django-ninja-jsonapi¶

django-ninja-jsonapi is a Django Ninja extension for building JSON:API-style REST APIs with a Django ORM data layer.

Main concepts¶

• JSON:API semantics: resource objects, relationships, includes, sparse fieldsets, filtering, sorting, pagination, and standardized errors.
• Logical data abstraction: schemas can expose a resource view that differs from raw model structure.
• Data layer separation: request parsing and endpoint orchestration are separated from ORM read/write behavior.

Features¶

• Resource registration and CRUD route generation
• Relationship and relationship-link routes
• Query parsing for filter, sort, include, fields, and page
• JSON:API error envelopes
• Atomic operations endpoint wiring (/operations)

Documentation¶

Getting started¶

• Getting started
• Installation
• Quickstart
• Standalone renderer

Usage¶

• Usage overview
• Routing
• Configuration
• Relationships
• Filtering
• Sorting
• Pagination
• Content Negotiation
• Inflection
• Errors

Examples¶

• Examples overview
• Minimal API (head)
• Minimal API example
• API filtering example
• Limited methods example

Reference and project¶

• API reference
• Development
• Testing
• Limitations & roadmap