Reference

API reference

Lookup pages for the public API. For explanations and examples, start from the guides.

Page	Covers
ModelSerializer	Schemas, schema attributes, Python methods and hooks on a model
Serializer	The same for a separate serializer class
SchemaConfig	Every option of a schema kind and the system checks
APIViewSet	Viewset attributes, endpoints and overridable methods
APIView	Endpoints that don't belong to a model
NinjaAIORouter	Grouping viewsets and views
Decorators	@action, @on, aatomic
Mixins	Filtering, search, permissions, soft delete, field selection
Authentication	JWT bearer and cookie auth, token helpers
Exceptions	Error classes and response shapes
Pagination	Paginators and their query parameters
JSON renderer	orjson rendering and parsing
Types	BulkResult, HttpMethod, relation and query schemas
Settings	Every Django setting the framework reads