JsonApiDotNetCore
JsonApiDotNetCore copied to clipboard
json-api-dotnet
A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.
Member order in swagger.json should be: `jsonapi`, `links`, `data`, `meta`. However, having `data` in-between cannot be done using STJ on .NET 5. Solutions to consider: flattening the type hierarchy, using...
Since v3 there has been a move to support orms other than efcore, #291 tracks Marten support, Mongo already exists as a separate package. Nhibernate is a well-known orm with...
The current OpenApi integration does not support any query parameters. The task is to describe the standard JsonApiDotNetCore query features as [query parameters](https://swagger.io/docs/specification/describing-parameters/#query-parameters) in the OAS: - filtering - sorting...
Currently the OpenApi integration only picks up on controllers that inherit from `JsonApiController`. This needs to be expanded so that the following are also picked up on: - `JsonApiQueryController` -...
Over time, several users have been asking for an alternative to adding attributes like [Attr] [HasOne] etc. EF Core provides both inline attributes, as well as a fluent API. This...
Swashbuckle comes with support for parsing XML docs throughout the codebase and including them in the OAS file. Further investigation is required to see how this works together with JADNC...
Currently the OpenApi integration takes into account the `JsonApiOptions.AllowClientGeneratedIds` option when generating schemas for resource objects, but this hasn't been thoroughly tested.
ID obfuscation involves inheritance from a class other than `Identifiable` for resources, see [ObfuscatedIdentifiable](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/test/JsonApiDotNetCoreExampleTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiable.cs). The custom schema generator will not be able to pick up on such customization out-of-the-box. Because...
A stance should be taken on how to handle custom controllers and custom actions (possibly with custom data types) within JADNC controllers.
The top-level `included` object needs to be included in the OpenApi schemas for response documents. Things to consider: - If the resource graph should be recursively parsed to identify which...
Metadata
Owner
Metadata
A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.