1. Quickstart

# in
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning'

# in
urlpatterns += [url(f'{API_PREFIX}/', include('drf_openapi.urls'))]

And voila! Your API documentation will be available at /<API_PREFIX>/schema

2. Add schema to a view method

DRF OpenAPI support the separation of response schema and request schema on a per view method basis through the use of a view_config decorator

from drf_openapi.utils import view_config

class SnippetList(APIView):
List all snippets, or create a new snippet.

    def get(self, request, version, format=None):
        snippets = Snippet.objects.all()
        res = self.response_serializer(snippets, many=True)
        return Response(res.validated_data)

    @view_config(request_serializer=SnippetSerializer, response_serializer=SnippetSerializer)
    def post(self, request, version, format=None):
        req = self.request_serializer(
        res = self.response_serializer(
        return Response(res.validated_data, status=status.HTTP_201_CREATED)

3. Add version to schema

DRF OpenAPI support schema versioning through versioning the serializers that the schema are generated from. To make a serializer version-specific, extends VersionedSerializers

from drf_openapi.entities import VersionedSerializers
from rest_framework import serializers

class SnippetSerializerV1(serializers.Serializer):
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)

class SnippetSerializerV2(SnippetSerializerV1):
    title = serializers.CharField(required=True, max_length=100)

class SnippetSerializer(VersionedSerializers):

    * **v1.0**: `title` is optional
    * **v2.0**: `title` is required

        ('>=1.0, <2.0', SnippetSerializerV1),
        ('>=2.0', SnippetSerializerV2),

That’s it. The view_config decorator will be able to correctly determined what serializer to use based on the request version at run time.

4. Add response status code to schema

By default, the response serializer’s fields and docstring, if specified, are associated with the 200 status code. Support for error status codes is provided through the use of Meta class in the serializer.

from rest_framework.status import HTTP_400_BAD_REQUEST

class SnippetSerializerV1(serializers.Serializer):
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)

    class Meta:
        error_status_codes = {
            HTTP_400_BAD_REQUEST: 'Bad Request'

In later iteration, I will add support for sample error response.

5. Customization of the API View

You can customize the API View that renders the schema documentation by subclassing it. It’s important to note that it is just a DRF APIView so it inherits all attributes available in an APIView. Therefore, if you want to customize the permissions to allow public access to your API documentation for example, which by default is staff-only IsAdminUser, you can do the following

# in your.project.views
from rest_framework import permissions
from drf_openapi.views import SchemaView

class MySchemaView(SchemaView):
    permission_classes = (permissions.AllowAny,)

# in your.project.urls
from your.project.views import MySchemaView
url('schema/$', MySchemaView.as_view(title='My Awesome API'), name='api_schema')

Take a look at the example project to see the default URL handler in action.