René's URL Explorer Experiment

Title: Streamline API surface by csantero · Pull Request #62 · JSONAPIdotNET/JSONAPI.NET · GitHub

Open Graph Title: Streamline API surface by csantero · Pull Request #62 · JSONAPIdotNET/JSONAPI.NET

X Title: Streamline API surface by csantero · Pull Request #62 · JSONAPIdotNET/JSONAPI.NET

Description: This is the first part of a refactor that I hope will make our library even simpler to setup. Rationale There are starting to become a lot of moving parts that the user has to configure to get JSONAPI.NET integrated with their project: IPluralizationService IModelManager JsonApiFormatter EnableFilteringAttribute EnableSortingAttribute EnumerateQueryableAsyncAttribute PascalizedControllerSelector ApiController-derived classes IMaterializer A lot of those components only fit together in one way, and trying to change their behavior will just break the system. For example, if you want filtering and sorting, you better remember to pass the same IModelManager instance to each of the attributes, as well as to the JsonApiFormatter. And the action filters have to be registered in the right order, since filtering should be applied before sorting (and when we introduce paging, it absolutely must take place after sorting). And then there is the async enumerator, which has to run after all the other action filters. I felt like I could internalize a lot of stuff and only expose a simple API with sensible defaults that does all of that for you. JsonApiConfiguration There is now a fluent interface for configuring JSONAPI.NET called JsonApiConfiguration. This object is responsible for setting up an HttpConfiguration object the way we need it. The user can currently use this fluent interface to disable sorting and/or filtering, and to provide a pluralization service. It also lets them opt-in to the async queryable enumerator using a fluent extension method. JsonApiQueryableAttribute I have combined the functionality of the filtering and sorting action filters into a new aggregate attribute called JsonApiQueryableAttribute. I abstracted the old filters into new constructs called IQueryableTransforms, and I pass those transforms to the JsonApiQueryableAttribute inside JsonApiConfiguration.Apply(). When we implement pagination we can make that an IQueryableTransform as well. Autofac I've taken on Autofac as a library dependency, and JsonApiConfiguration uses it internally to manage the construction of our various components (JsonApiFormatter, ModelManager, JsonApiQueryableAttribute, etc.). At the moment the container I use for this purpose is not integrated with the HttpConfiguration's dependency resolver and will not interfere with controller instance DI. Still to do The JsonApiFormatter can be cleaned up to be internal and use a single constructor. If we want to inject our own services onto controller instances (such as IMetadataManager), then I believe we will need to take over setting the IDependencyResolver. If we do this, however, we will be forcing the user to use Autofac for resolving controller dependencies, which sounds pretty heavy-handed. At the very least we'd have to give them access to the ContainerBuilder for customization. ModelManager and IModelManager can be made internal. PascalizedControllerSelector can be made internal. Some links Example JsonApiConfiguration JsonApiConfiguration definition

Open Graph Description: This is the first part of a refactor that I hope will make our library even simpler to setup. Rationale There are starting to become a lot of moving parts that the user has to configure to get JSON...

X Description: This is the first part of a refactor that I hope will make our library even simpler to setup. Rationale There are starting to become a lot of moving parts that the user has to configure to get JSON...

Opengraph URL: https://github.com/JSONAPIdotNET/JSONAPI.NET/pull/62

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width