Welcome to Django REST framework JSON:API

Contents:

• Getting Started
  • Requirements
  • Installation
  • Running the example app
  • Running Tests
• Usage
  • Configuration
  • Pagination
  • Filter Backends
  • Error objects / Exception handling
  • Performance Testing
  • Serializers
  • Overwriting the resource object’s id
  • Setting resource identifier object type
  • Build JSON:API view output manually
  • Inflecting object and relation keys
  • Related fields
  • RelationshipView
  • Working with polymorphic resources
  • Meta
  • Links
  • Included
  • Generating an OpenAPI Specification (OAS) 3.0 schema document
  • Third Party Packages
• API Reference
  • rest_framework_json_api package
• Contributing
  • Setup development environment
  • For maintainers

Indices and tables

• Index

• Search Page