|
1 | | -# API |
| 1 | +# Public API surface |
2 | 2 |
|
3 | | -This section documents the package API and is generated from the XML source comments. |
| 3 | +This topic documents the public API, which is generated from the triple-slash XML documentation comments in source code. |
| 4 | +Commonly used types are listed in the following sections. |
4 | 5 |
|
5 | | -## Common APIs |
| 6 | +## Setup |
6 | 7 |
|
7 | | -- [`JsonApiOptions`](JsonApiDotNetCore.Configuration.JsonApiOptions.yml) |
8 | | -- [`IResourceGraph`](JsonApiDotNetCore.Configuration.IResourceGraph.yml) |
9 | | -- [`JsonApiResourceDefinition<TResource, TId>`](JsonApiDotNetCore.Resources.JsonApiResourceDefinition-2.yml) |
| 8 | +- <xref:JsonApiDotNetCore.Configuration.JsonApiOptions> implements <xref:JsonApiDotNetCore.Configuration.IJsonApiOptions> |
| 9 | +- <xref:JsonApiDotNetCore.Configuration.ResourceGraph> implements <xref:JsonApiDotNetCore.Configuration.IResourceGraph> |
| 10 | + - <xref:JsonApiDotNetCore.Configuration.ResourceType> |
| 11 | + - <xref:JsonApiDotNetCore.Resources.Identifiable`1> implements <xref:JsonApiDotNetCore.Resources.IIdentifiable`1> |
| 12 | + - <xref:JsonApiDotNetCore.Resources.Annotations.ResourceAttribute> and <xref:JsonApiDotNetCore.Resources.Annotations.NoResourceAttribute> |
| 13 | + - <xref:JsonApiDotNetCore.Resources.Annotations.ResourceLinksAttribute> |
| 14 | + - <xref:JsonApiDotNetCore.Resources.Annotations.AttrAttribute> |
| 15 | + - <xref:JsonApiDotNetCore.Resources.Annotations.HasOneAttribute> |
| 16 | + - <xref:JsonApiDotNetCore.Resources.Annotations.HasManyAttribute> |
| 17 | + - <xref:JsonApiDotNetCore.Resources.Annotations.EagerLoadAttribute> |
| 18 | +- <xref:JsonApiDotNetCore.Configuration.ServiceCollectionExtensions>, <xref:JsonApiDotNetCore.OpenApi.Swashbuckle.ServiceCollectionExtensions> (OpenAPI) |
| 19 | +- <xref:JsonApiDotNetCore.Configuration.ApplicationBuilderExtensions> |
| 20 | +- <xref:JsonApiDotNetCore.Middleware.JsonApiRoutingConvention> implements <xref:JsonApiDotNetCore.Middleware.IJsonApiRoutingConvention> |
| 21 | + - <xref:JsonApiDotNetCore.Controllers.Annotations.DisableRoutingConventionAttribute> |
| 22 | + - <xref:JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute> |
| 23 | + |
| 24 | +## Query strings |
| 25 | + |
| 26 | +- <xref:JsonApiDotNetCore.Middleware.AsyncQueryStringActionFilter> implements <xref:JsonApiDotNetCore.Middleware.IAsyncQueryStringActionFilter> |
| 27 | + - <xref:JsonApiDotNetCore.QueryStrings.QueryStringReader> implements <xref:JsonApiDotNetCore.QueryStrings.IQueryStringReader> |
| 28 | + - <xref:JsonApiDotNetCore.QueryStrings.IQueryStringParameterReader> and <xref:JsonApiDotNetCore.Queries.IQueryConstraintProvider> |
| 29 | + - <xref:JsonApiDotNetCore.QueryStrings.IncludeQueryStringParameterReader> implements <xref:JsonApiDotNetCore.QueryStrings.IIncludeQueryStringParameterReader> |
| 30 | + - <xref:JsonApiDotNetCore.Queries.Parsing.IncludeParser> implements <xref:JsonApiDotNetCore.Queries.Parsing.IIncludeParser> |
| 31 | + - <xref:JsonApiDotNetCore.QueryStrings.FilterQueryStringParameterReader> implements <xref:JsonApiDotNetCore.QueryStrings.IFilterQueryStringParameterReader> |
| 32 | + - <xref:JsonApiDotNetCore.Queries.Parsing.FilterParser> implements <xref:JsonApiDotNetCore.Queries.Parsing.IFilterParser> |
| 33 | + - <xref:JsonApiDotNetCore.QueryStrings.SortQueryStringParameterReader> implements <xref:JsonApiDotNetCore.QueryStrings.ISortQueryStringParameterReader> |
| 34 | + - <xref:JsonApiDotNetCore.Queries.Parsing.SortParser> implements <xref:JsonApiDotNetCore.Queries.Parsing.ISortParser> |
| 35 | + - <xref:JsonApiDotNetCore.QueryStrings.PaginationQueryStringParameterReader> implements <xref:JsonApiDotNetCore.QueryStrings.IPaginationQueryStringParameterReader> |
| 36 | + - <xref:JsonApiDotNetCore.Queries.Parsing.PaginationParser> implements <xref:JsonApiDotNetCore.Queries.Parsing.IPaginationParser> |
| 37 | + - <xref:JsonApiDotNetCore.QueryStrings.SparseFieldSetQueryStringParameterReader> implements <xref:JsonApiDotNetCore.QueryStrings.ISparseFieldSetQueryStringParameterReader> |
| 38 | + - <xref:JsonApiDotNetCore.Queries.Parsing.SparseFieldSetParser> implements <xref:JsonApiDotNetCore.Queries.Parsing.ISparseFieldSetParser> |
| 39 | +- <xref:JsonApiDotNetCore.Queries.QueryLayer> |
| 40 | + - <xref:JsonApiDotNetCore.Queries.FieldSelection> |
| 41 | + - <xref:JsonApiDotNetCore.Queries.Expressions.QueryExpression> |
| 42 | + - <xref:JsonApiDotNetCore.Queries.Expressions.IncludeExpression> |
| 43 | + - <xref:JsonApiDotNetCore.Queries.Expressions.FilterExpression> |
| 44 | + - <xref:JsonApiDotNetCore.Queries.Expressions.SortExpression> |
| 45 | + - <xref:JsonApiDotNetCore.Queries.Expressions.PaginationExpression> |
| 46 | + - <xref:JsonApiDotNetCore.Queries.Expressions.SparseFieldSetExpression> |
| 47 | +- <xref:JsonApiDotNetCore.Queries.QueryableBuilding.QueryableBuilder> implements <xref:JsonApiDotNetCore.Queries.QueryableBuilding.IQueryableBuilder> |
| 48 | + - <xref:JsonApiDotNetCore.Queries.QueryableBuilding.IncludeClauseBuilder> implements <xref:JsonApiDotNetCore.Queries.QueryableBuilding.IIncludeClauseBuilder> |
| 49 | + - <xref:JsonApiDotNetCore.Queries.QueryableBuilding.WhereClauseBuilder> implements <xref:JsonApiDotNetCore.Queries.QueryableBuilding.IWhereClauseBuilder> |
| 50 | + - <xref:JsonApiDotNetCore.Queries.QueryableBuilding.OrderClauseBuilder> implements <xref:JsonApiDotNetCore.Queries.QueryableBuilding.IOrderClauseBuilder> |
| 51 | + - <xref:JsonApiDotNetCore.Queries.QueryableBuilding.SkipTakeClauseBuilder> implements <xref:JsonApiDotNetCore.Queries.QueryableBuilding.ISkipTakeClauseBuilder> |
| 52 | + - <xref:JsonApiDotNetCore.Queries.QueryableBuilding.SelectClauseBuilder> implements <xref:JsonApiDotNetCore.Queries.QueryableBuilding.ISelectClauseBuilder> |
| 53 | + |
| 54 | +## Request pipeline |
| 55 | + |
| 56 | +- <xref:JsonApiDotNetCore.Controllers.JsonApiController`2> implements <xref:JsonApiDotNetCore.Controllers.BaseJsonApiController`2> |
| 57 | + - <xref:JsonApiDotNetCore.Controllers.JsonApiQueryController`2> |
| 58 | + - <xref:JsonApiDotNetCore.Controllers.JsonApiCommandController`2> |
| 59 | +- <xref:JsonApiDotNetCore.Controllers.JsonApiOperationsController> implements <xref:JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController> |
| 60 | + - <xref:JsonApiDotNetCore.AtomicOperations.OperationsProcessor> implements <xref:JsonApiDotNetCore.AtomicOperations.IOperationsProcessor> |
| 61 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.IOperationProcessor> |
| 62 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor`2> implements <xref:JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor`2> |
| 63 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.UpdateProcessor`2> implements <xref:JsonApiDotNetCore.AtomicOperations.Processors.IUpdateProcessor`2> |
| 64 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.DeleteProcessor`2> implements <xref:JsonApiDotNetCore.AtomicOperations.Processors.IDeleteProcessor`2> |
| 65 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.SetRelationshipProcessor`2> implements <xref:JsonApiDotNetCore.AtomicOperations.Processors.ISetRelationshipProcessor`2> |
| 66 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.AddToRelationshipProcessor`2> implements <xref:JsonApiDotNetCore.AtomicOperations.Processors.IAddToRelationshipProcessor`2> |
| 67 | + - <xref:JsonApiDotNetCore.AtomicOperations.Processors.RemoveFromRelationshipProcessor`2> implements <xref:JsonApiDotNetCore.AtomicOperations.Processors.IRemoveFromRelationshipProcessor`2> |
| 68 | +- <xref:JsonApiDotNetCore.Middleware.JsonApiMiddleware> |
| 69 | + - <xref:JsonApiDotNetCore.Middleware.JsonApiRequest> implements <xref:JsonApiDotNetCore.Middleware.IJsonApiRequest> |
| 70 | +- <xref:JsonApiDotNetCore.Services.JsonApiResourceService`2> implements <xref:JsonApiDotNetCore.Services.IResourceService`2> |
| 71 | +- <xref:JsonApiDotNetCore.Queries.QueryLayerComposer> implements <xref:JsonApiDotNetCore.Queries.IQueryLayerComposer> |
| 72 | + - <xref:JsonApiDotNetCore.Resources.JsonApiResourceDefinition`2> implements <xref:JsonApiDotNetCore.Resources.IResourceDefinition`2> |
| 73 | +- <xref:JsonApiDotNetCore.Repositories.EntityFrameworkCoreRepository`2> implements <xref:JsonApiDotNetCore.Repositories.IResourceRepository`2> |
| 74 | + - <xref:JsonApiDotNetCore.Repositories.IResourceReadRepository`2> |
| 75 | + - <xref:JsonApiDotNetCore.Repositories.IResourceWriteRepository`2> |
| 76 | + |
| 77 | +## Serialization |
| 78 | + |
| 79 | +- <xref:JsonApiDotNetCore.Middleware.JsonApiInputFormatter> implements <xref:JsonApiDotNetCore.Middleware.IJsonApiInputFormatter> |
| 80 | + - <xref:JsonApiDotNetCore.Serialization.Request.JsonApiReader> implements <xref:JsonApiDotNetCore.Serialization.Request.IJsonApiReader> |
| 81 | + - <xref:JsonApiDotNetCore.Serialization.Request.Adapters.DocumentAdapter> implements <xref:JsonApiDotNetCore.Serialization.Request.Adapters.IDocumentAdapter> |
| 82 | + - <xref:JsonApiDotNetCore.Resources.TargetedFields> implements <xref:JsonApiDotNetCore.Resources.ITargetedFields> |
| 83 | +- <xref:JsonApiDotNetCore.Middleware.JsonApiOutputFormatter> implements <xref:JsonApiDotNetCore.Middleware.IJsonApiOutputFormatter> |
| 84 | + - <xref:JsonApiDotNetCore.Serialization.Response.JsonApiWriter> implements <xref:JsonApiDotNetCore.Serialization.Response.IJsonApiWriter> |
| 85 | + - <xref:JsonApiDotNetCore.Serialization.Response.ResponseModelAdapter> implements <xref:JsonApiDotNetCore.Serialization.Response.IResponseModelAdapter> |
| 86 | +- <xref:JsonApiDotNetCore.Serialization.Objects.Document> |
| 87 | +- <xref:JsonApiDotNetCore.Queries.IEvaluatedIncludeCache> |
| 88 | +- <xref:JsonApiDotNetCore.Queries.SparseFieldSetCache> implements <xref:JsonApiDotNetCore.Queries.ISparseFieldSetCache> |
| 89 | + |
| 90 | +## Error handling |
| 91 | + |
| 92 | +- <xref:JsonApiDotNetCore.Middleware.AsyncJsonApiExceptionFilter> implements <xref:JsonApiDotNetCore.Middleware.IAsyncJsonApiExceptionFilter> |
| 93 | + - <xref:JsonApiDotNetCore.Middleware.ExceptionHandler> implements <xref:JsonApiDotNetCore.Middleware.IExceptionHandler> |
0 commit comments