drf-spectacular

=============== drf-spectacular

|build-status| |codecov| |docs| |pypi-version| |pypi-dl|

Sane and flexible OpenAPI_ (3.0.3, 3.1 & 3.2) schema generation for Django REST framework.

This project has 3 goals: 1. Extract as much schema information from DRF as possible. 2. Provide flexibility to make the schema usable in the real world (not only toy examples). 3. Generate a schema that works well with the most popular client generators.

The code is a heavily modified fork of the DRF OpenAPI generator <https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas/openapi.py/>_, which is/was lacking all of the below listed features.

Features - Serializers modelled as components. (arbitrary nesting and recursion supported) - @extend_schema <https://drf-spectacular.readthedocs.io/en/latest/drf_spectacular.html#drf_spectacular.utils.extend_schema>_ decorator for customization of APIView, Viewsets, function-based views, and @action - additional parameters - request/response serializer override (with status codes) - polymorphic responses either manually with PolymorphicProxySerializer helper or via rest_polymorphic’s PolymorphicSerializer) - … and more customization options - Authentication support (DRF natives included, easily extendable) - Custom serializer class support (easily extendable) - SerializerMethodField() <https://drf-spectacular.readthedocs.io/en/latest/customization.html#step-3-extend-schema-field-and-type-hints>_ type via type hinting or @extend_schema_field - i18n support - Tags extraction - Request/response/parameter examples - Description extraction from docstrings - Vendor specification extensions (x-*) in info, operations, parameters, components, and security schemes - Sane fallbacks - Sane operation_id naming (based on path) - Schema serving with SpectacularAPIView (Redoc and Swagger-UI views are also available) - Optional input/output serializer component split - Callback operations - OpenAPI 3.1 support (via setting OAS_VERSION) - Included support for: - django-polymorphic <https://github.com/django-polymorphic/django-polymorphic>_ / django-rest-polymorphic <https://github.com/apirobot/django-rest-polymorphic>_ - SimpleJWT <https://github.com/jazzband/djangorestframework-simplejwt>_ - DjangoOAuthToolkit <https://github.com/jazzband/django-oauth-toolkit>_ - djangorestframework-jwt <https://github.com/jpadilla/django-rest-framework-jwt>_ (tested fork drf-jwt <https://github.com/Styria-Digital/django-rest-framework-jwt>) - dj-rest-auth <https://github.com/iMerica/dj-rest-auth> (maintained fork of django-rest-auth <https://github.com/Tivix/django-rest-auth>) - djangorestframework-camel-case <https://github.com/vbabiy/djangorestframework-camel-case> (via postprocessing hook camelize_serializer_fields) - django-filter <https://github.com/carltongibson/django-filter>_ - drf-nested-routers <https://github.com/alanjds/drf-nested-routers>_ - djangorestframework-recursive <https://github.com/heywbj/django-rest-framework-recursive>_ - djangorestframework-dataclasses <https://github.com/oxan/djangorestframework-dataclasses>_ - django-rest-framework-gis <https://github.com/openwisp/django-rest-framework-gis>_ - Pydantic (>=2.0) <https://github.com/pydantic/pydantic>_ - django-rest-knox <https://github.com/jazzband/django-rest-knox>_

For more information visit the documentation <https://drf-spectacular.readthedocs.io/>_.

License

Provided by T. Franzel <https://github.com/tfranzel>. Licensed under 3-Clause BSD <https://github.com/tfranzel/drf-spectacular/blob/master/LICENSE>.

Requirements

• Python >= 3.8
• Django (3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2, 6.0)
• Django REST Framework (3.12, 3.13, 3.14, 3.15, 3.16, 3.17)

Installation

Install using pip\ …

… code:: bash

$ pip install drf-spectacular

then add drf-spectacular to installed apps in settings.py

… code:: python

INSTALLED_APPS = [
    # ALL YOUR APPS
    'drf_spectacular',
]

and finally register our spectacular AutoSchema with DRF.

… code:: python

REST_FRAMEWORK = {
    # YOUR SETTINGS
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
}

drf-spectacular ships with sane default settings <https://drf-spectacular.readthedocs.io/en/latest/settings.html>_ that should work reasonably well out of the box. It is not necessary to specify any settings, but we recommend to specify at least some metadata.

… code:: python

SPECTACULAR_SETTINGS = {
    'TITLE': 'Your Project API',
    'DESCRIPTION': 'Your project description',
    'VERSION': '1.0.0',
    'SERVE_INCLUDE_SCHEMA': False,
    # OTHER SETTINGS
}

… _self-contained-ui-installation:

Self-contained UI installation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Certain environments have no direct access to the internet and as such are unable to retrieve Swagger UI or Redoc from CDNs. drf-spectacular-sidecar_ provides these static files as a separate optional package. Usage is as follows:

… code:: bash

$ pip install drf-spectacular[sidecar]

… code:: python

INSTALLED_APPS = [
    # ALL YOUR APPS
    'drf_spectacular',
    'drf_spectacular_sidecar',  # required for Django collectstatic discovery
]
SPECTACULAR_SETTINGS = {
    'SWAGGER_UI_DIST': 'SIDECAR',  # shorthand to use the sidecar instead
    'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',
    'REDOC_DIST': 'SIDECAR',
    # OTHER SETTINGS
}

Release management ^^^^^^^^^^^^^^^^^^

drf-spectacular deliberately stays below version 1.x.x to signal that every new version may potentially break you. For production we strongly recommend pinning the version and inspecting a schema diff on update.

With that said, we aim to be extremely defensive w.r.t. breaking API changes. However, we also acknowledge the fact that even slight schema changes may break your toolchain, as any existing bug may somehow also be used as a feature.

We define version increments with the following semantics. y-stream increments may contain potentially breaking changes to both API and schema. z-stream increments will never break the API and may only contain schema changes that should have a low chance of breaking you.

Take it for a spin

Generate your schema with the CLI:

… code:: bash

$ ./manage.py spectacular --color --file schema.yml
$ docker run -p 8080:8080 -e SWAGGER_JSON=/schema.yml -v ${PWD}/schema.yml:/schema.yml swaggerapi/swagger-ui

If you also want to validate your schema add the --validate flag. Or serve your schema directly from your API. We also provide convenience wrappers for swagger-ui or redoc.

… code:: python

from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
urlpatterns = [
    # YOUR PATTERNS
    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
    # Optional UI:
    path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
    path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
]

Usage

drf-spectacular works pretty well out of the box. You might also want to set some metadata for your API. Just create a SPECTACULAR_SETTINGS dictionary in your settings.py and override the defaults. Have a look at the available settings <https://drf-spectacular.readthedocs.io/en/latest/settings.html>_.

The toy examples do not cover your cases? No problem, you can heavily customize how your schema will be rendered.

Customization by using @extend_schema ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Most customization cases should be covered by the extend_schema decorator. We usually get pretty far with specifying OpenApiParameter and splitting request/response serializers, but the sky is the limit.

… code:: python

from drf_spectacular.utils import extend_schema, OpenApiParameter, OpenApiExample
from drf_spectacular.types import OpenApiTypes

class AlbumViewset(viewset.ModelViewset):
    serializer_class = AlbumSerializer

    @extend_schema(
        request=AlbumCreationSerializer,
        responses={201: AlbumSerializer},
    )
    def create(self, request):
        # your non-standard behaviour
        return super().create(request)

    @extend_schema(
        # extra parameters added to the schema
        parameters=[
            OpenApiParameter(name='artist', description='Filter by artist', required=False, type=str),
            OpenApiParameter(
                name='release',
                type=OpenApiTypes.DATE,
                location=OpenApiParameter.QUERY,
                description='Filter by release date',
                examples=[
                    OpenApiExample(
                        'Example 1',
                        summary='short optional summary',
                        description='longer description',
                        value='1993-08-23'
                    ),
                    ...
                ],
            ),
        ],
        # override default docstring extraction
        description='More descriptive text',
        # provide Authentication class that deviates from the views default
        auth=None,
        # change the auto-generated operation name
        operation_id=None,
        # or even completely override what AutoSchema would generate. Provide raw Open API spec as Dict.
        operation=None,
        # attach request/response examples to the operation.
        examples=[
            OpenApiExample(
                'Example 1',
                description='longer description',
                value=...
            ),
            ...
        ],
    )
    def list(self, request):
        # your non-standard behaviour
        return super().list(request)

    @extend_schema(
        request=AlbumLikeSerializer,
        responses={204: None},
        methods=["POST"]
    )
    @extend_schema(description='Override a specific method', methods=["GET"])
    @action(detail=True, methods=['post', 'get'])
    def set_password(self, request, pk=None):
        # your action behaviour
        ...

More customization ^^^^^^^^^^^^^^^^^^

Still not satisfied? You want more! We still got you covered. Visit customization <https://drf-spectacular.readthedocs.io/en/latest/customization.html>_ for more information.

Testing

Install testing requirements.

… code:: bash

$ pip install -r requirements.txt

Run with runtests.

… code:: bash

$ ./runtests.py

You can also use the excellent tox_ testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

… code:: bash

$ tox

… _Django REST framework: https://www.django-rest-framework.org/ … _OpenAPI: https://swagger.io/ … _3.0.3: https://spec.openapis.org/oas/v3.0.3 … _3.1: https://spec.openapis.org/oas/v3.1.0 … _3.2: https://spec.openapis.org/oas/v3.2.0 … _tox: https://tox.wiki/ … _drf-spectacular-sidecar: https://github.com/tfranzel/drf-spectacular-sidecar

… |build-status| image:: https://github.com/tfranzel/drf-spectacular/actions/workflows/ci.yml/badge.svg :target: https://github.com/tfranzel/drf-spectacular/actions/workflows/ci.yml … |pypi-version| image:: https://img.shields.io/pypi/v/drf-spectacular.svg :target: https://pypi.org/project/drf-spectacular/ … |codecov| image:: https://codecov.io/gh/tfranzel/drf-spectacular/branch/master/graph/badge.svg :target: https://codecov.io/gh/tfranzel/drf-spectacular … |docs| image:: https://readthedocs.org/projects/drf-spectacular/badge/ :target: https://drf-spectacular.readthedocs.io/ … |pypi-dl| image:: https://img.shields.io/pypi/dm/drf-spectacular :target: https://pypi.org/project/drf-spectacular/