Using drf-spectacular for openapi 3

Author: thenav56

main/settings.py

@@ -140,7 +140,7 @@
 INSTALLED_APPS = [
     # External App (This app has to defined before django.contrib.admin)
     'modeltranslation',  # https://django-modeltranslation.readthedocs.io/en/latest/installation.html#installed-apps
-    'drf_yasg',
+    'drf_spectacular',
 
     # Django Apps
     'django.contrib.admin',
@@ -208,7 +208,7 @@
         'rest_framework.renderers.BrowsableAPIRenderer',
         'rest_framework_csv.renderers.PaginatedCSVRenderer',
     ),
-    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
 }
 
 GRAPHENE = {
@@ -559,7 +559,12 @@
 }
 CACHE_MIDDLEWARE_SECONDS = env('CACHE_MIDDLEWARE_SECONDS')  # Planned: 600 for staging, 60 from prod
 
-OPEN_API_DOCS_TIMEOUT = 60
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'IFRC-GO API',
+    'DESCRIPTION': 'IFRC-GO API Documenation',
+    'VERSION': '1.0.0',
+    'SERVE_INCLUDE_SCHEMA': False,
+}
 
 # Need to load this to overwrite modeltranslation module
 import main.translation  # noqa: F401 E402

main/urls.py

@@ -75,8 +75,7 @@
 from rest_framework import routers
 from rest_framework.documentation import include_docs_urls
 from rest_framework import permissions
-from drf_yasg.views import get_schema_view
-from drf_yasg import openapi
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
 from api import drf_views as api_views
 from flash_update import views as flash_views
 from per import drf_views as per_views
@@ -171,17 +170,6 @@
 
 router.register(r"review-country", api_views.CountryOfFieldReportToReviewViewset, basename="review_country")
 
-api_schema_view = get_schema_view(
-    openapi.Info(
-        title="IFRC-GO API",
-        default_version='v1',
-        description="IFRC-GO API Openapi schema",
-        contact=openapi.Contact(email="[email protected]"),  # TODO: Update this
-    ),
-    public=True,
-    permission_classes=(permissions.AllowAny,),
-)
-
 # Country Plan apis
 router.register(r"country-plan", country_plan_views.CountryPlanViewset, basename="country_plan")
 
@@ -244,16 +232,19 @@
     url(r"^api/v2/exportperresults/", per_views.ExportAssessmentToCSVViewset.as_view()),
     url(r"^api/v2/local-unit/(?P<pk>\d+)", LocalUnitDetailAPIView.as_view()),
     url(r"^api/v2/local-unit/", LocalUnitListAPIView.as_view()),
-    url(r"^docs/", include_docs_urls(title="IFRC GO API", public=False)),
-    url(r'^api-docs(?P<format>\.json|\.yaml)$',
-            api_schema_view.without_ui(cache_timeout=settings.OPEN_API_DOCS_TIMEOUT), name='api-schema'),
     url(r"^tinymce/", include("tinymce.urls")),
     url(r"^$", RedirectView.as_view(url="/admin")),
     # url(r'^', admin.site.urls),
     url(r"^favicon\.ico$", RedirectView.as_view(url="/static/favicon.ico")),
     url(r"^server-error-for-devs", DummyHttpStatusError.as_view()),
     url(r"^exception-error-for-devs", DummyExceptionError.as_view()),
     path("i18n/", include("django.conf.urls.i18n")),
+    # Docs
+    url(r"^docs/", include_docs_urls(title="IFRC GO API", public=False)),  # TODO: Remove this?
+    path("api-docs/", SpectacularAPIView.as_view(), name='schema'),
+    path("api-docs/swagger-ui/", SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+    path("api-docs/redoc/", SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
+
 ]
 
 if settings.DEBUG:

poetry.lock

@@ -81,7 +81,7 @@ celery = { version = "==5.1.2", extras = ["redis"] }
 django-redis = "==5.0.0"
 sentry-sdk = "*"
 django-haystack = { version = "*", extras = ["elasticsearch"] }
-drf_yasg = "*"
+drf-spectacular = "*"
 
 mapbox-tilesets = "*"
 ipython = "*"