drf-connect-docs

Contents:

  • Getting started
  • User guide
  • API Reference
  • Changelog
drf-connect-docs
  • Django Rest Framework Connect OpenAPI definitions generator
  • View page source

Django Rest Framework Connect OpenAPI definitions generator

drf-connect-docs aims to fill the gap between DRF’s current support for the OpenAPI specification and OpenAPI version 3. For more information about OpenAPI 3.x specifications visit http://spec.openapis.org/oas/v3.0.3.

Contents:

  • Getting started
    • Requirements
    • Install
    • Configure
  • User guide
    • Operations
    • Headers
    • Filters
    • Path parameters
    • Manual parameters
    • Serializers
    • SerializerMethodField (or the to_representation serializer method)
    • JSONField
    • Manual responses
    • Groups operations with tags
    • Per-view customization
    • Different request/response serializer
    • Customize schema for specific action/method
    • Customize tags
    • Customize models names
  • API Reference
    • Generator
    • Schema
    • Inspectors
    • Registries
    • Utilities
    • Settings
  • Changelog
    • 1.5.0
    • 1.4.0
    • 1.3.4
    • 1.3.3
    • 1.3.2
    • 1.3.1
    • 1.3.0
    • 1.2.0
    • 1.1.1
    • 1.1.0
    • 1.0.0

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2020, CloudBlue Inc..

Built with Sphinx using a theme provided by Read the Docs.