YASG: The Redoc Swagger UI for Django/DRF

#python #django #webdev #opensource

Concepts

Generate real Swagger/OpenAPI 2.0 specifications from a Django Rest Framework API.

Compatible with

Django Rest Framework: 3.10, 3.11, 3.12
Django: 2.2, 3.0, 3.1
Python: 3.6, 3.7, 3.8, 3.9

Getting started

1) Installation

The preferred instalation method is directly from pypi:

pip install drf-yasg

2) Quickstart

In settings.py:

INSTALLED_APPS = [
   ...
   'django.contrib.staticfiles',  # required for serving swagger ui's css/js files
   'drf_yasg',
   ...
]

In urls.py:

...
from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi

...

schema_view = get_schema_view(
   openapi.Info(
      title="Snippets API",
      default_version='v1',
      description="Test description",
      terms_of_service="https://www.google.com/policies/terms/",
      contact=openapi.Contact(email="contact@snippets.local"),
      license=openapi.License(name="BSD License"),
   ),
   public=True,
   permission_classes=[permissions.AllowAny],
)

urlpatterns = [
   url(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
   url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
   url(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
   ...
]