Public API surface

This topic documents the public API, which is generated from the triple-slash XML documentation comments in source code. Commonly used types are listed in the following sections.

Setup

• JsonApiOptions implements IJsonApiOptions
• ResourceGraph implements IResourceGraph
  • ResourceType
  • Identifiable<TId> implements IIdentifiable<TId>
    • ResourceAttribute and NoResourceAttribute
    • ResourceLinksAttribute
    • AttrAttribute
    • HasOneAttribute
    • HasManyAttribute
    • EagerLoadAttribute
• ApplicationBuilderExtensions
• JsonApiRoutingConvention implements IJsonApiRoutingConvention
  • DisableRoutingConventionAttribute
  • DisableQueryStringAttribute

Query strings

• AsyncQueryStringActionFilter implements IAsyncQueryStringActionFilter
  • QueryStringReader implements IQueryStringReader
    • IQueryStringParameterReader and IQueryConstraintProvider
      • IncludeQueryStringParameterReader implements IIncludeQueryStringParameterReader
        • IncludeParser implements IIncludeParser
      • FilterQueryStringParameterReader implements IFilterQueryStringParameterReader
        • FilterParser implements IFilterParser
      • SortQueryStringParameterReader implements ISortQueryStringParameterReader
        • SortParser implements ISortParser
      • PaginationQueryStringParameterReader implements IPaginationQueryStringParameterReader
        • PaginationParser implements IPaginationParser
      • SparseFieldSetQueryStringParameterReader implements ISparseFieldSetQueryStringParameterReader
        • SparseFieldSetParser implements ISparseFieldSetParser
• QueryLayer
  • FieldSelection
  • QueryExpression
    • IncludeExpression
    • FilterExpression
    • SortExpression
    • PaginationExpression
    • SparseFieldSetExpression
• QueryableBuilder implements IQueryableBuilder
  • IncludeClauseBuilder implements IIncludeClauseBuilder
  • WhereClauseBuilder implements IWhereClauseBuilder
  • OrderClauseBuilder implements IOrderClauseBuilder
  • SkipTakeClauseBuilder implements ISkipTakeClauseBuilder
  • SelectClauseBuilder implements ISelectClauseBuilder

Request pipeline

• JsonApiController<TResource, TId> implements BaseJsonApiController<TResource, TId>
  • JsonApiQueryController<TResource, TId>
  • JsonApiCommandController<TResource, TId>
• JsonApiOperationsController implements BaseJsonApiOperationsController
  • OperationsProcessor implements IOperationsProcessor
    • IOperationProcessor
      • CreateProcessor<TResource, TId> implements ICreateProcessor<TResource, TId>
      • UpdateProcessor<TResource, TId> implements IUpdateProcessor<TResource, TId>
      • DeleteProcessor<TResource, TId> implements IDeleteProcessor<TResource, TId>
      • SetRelationshipProcessor<TResource, TId> implements ISetRelationshipProcessor<TResource, TId>
      • AddToRelationshipProcessor<TResource, TId> implements IAddToRelationshipProcessor<TResource, TId>
      • RemoveFromRelationshipProcessor<TResource, TId> implements IRemoveFromRelationshipProcessor<TResource, TId>
• JsonApiMiddleware
  • JsonApiRequest implements IJsonApiRequest
• JsonApiResourceService<TResource, TId> implements IResourceService<TResource, TId>
• QueryLayerComposer implements IQueryLayerComposer
  • JsonApiResourceDefinition<TResource, TId> implements IResourceDefinition<TResource, TId>
• EntityFrameworkCoreRepository<TResource, TId> implements IResourceRepository<TResource, TId>
  • IResourceReadRepository<TResource, TId>
  • IResourceWriteRepository<TResource, TId>

Serialization

• JsonApiInputFormatter implements IJsonApiInputFormatter
  • JsonApiReader implements IJsonApiReader
    • DocumentAdapter implements IDocumentAdapter
      • TargetedFields implements ITargetedFields
• JsonApiOutputFormatter implements IJsonApiOutputFormatter
  • JsonApiWriter implements IJsonApiWriter
    • ResponseModelAdapter implements IResponseModelAdapter
• Document
• IEvaluatedIncludeCache
• SparseFieldSetCache implements ISparseFieldSetCache

Error handling

• AsyncJsonApiExceptionFilter implements IAsyncJsonApiExceptionFilter
  • ExceptionHandler implements IExceptionHandler