Namespace JsonApiDotNetCore.Resources.Annotations
Classes
- AttrAttribute
Used to expose a property on a resource class as a JSON:API attribute (https://jsonapi.org/format/#document-resource-object-attributes).
- EagerLoadAttribute
Used to unconditionally load a related entity that is not exposed as a JSON:API relationship.
- HasManyAttribute
Used to expose a property on a resource class as a JSON:API to-many relationship (https://jsonapi.org/format/#document-resource-object-relationships).
- HasOneAttribute
Used to expose a property on a resource class as a JSON:API to-one relationship (https://jsonapi.org/format/#document-resource-object-relationships).
- NoResourceAttribute
When put on an Entity Framework Core entity, indicates that the type should not be added to the resource graph. This effectively suppresses the warning at startup that this type does not implement IIdentifiable .
- RelationshipAttribute
Used to expose a property on a resource class as a JSON:API relationship (https://jsonapi.org/format/#document-resource-object-relationships).
- ResourceAttribute
When put on a resource class, overrides the convention-based public resource name and auto-generates an ASP.NET controller.
- ResourceFieldAttribute
Used to expose a property on a resource class as a JSON:API field (attribute or relationship). See https://jsonapi.org/format/#document-resource-object-fields.
- ResourceLinksAttribute
When put on a resource class, overrides global configuration for which links to render.
Enums
- AttrCapabilities
Indicates what can be performed on an AttrAttribute.
- HasManyCapabilities
Indicates what can be performed on a HasManyAttribute.
- HasOneCapabilities
Indicates what can be performed on a HasOneAttribute.