Merge pull request #76 from darjeeling/swagger_drf_spectacular

add swagger using drf-spectacular

Author: golony6449

pyconweb2022/pyconweb2022/settings.py

@@ -47,6 +47,7 @@
     "content",
     "zappa_django_utils",
     "martor",
+    "drf_spectacular",
 ]
 
 MIDDLEWARE = [
@@ -146,7 +147,8 @@
 REST_FRAMEWORK = {
     "DEFAULT_PERMISSION_CLASSES": [
         "rest_framework.permissions.IsAuthenticated",
-    ]
+    ],
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
 
 # Amazon SES

pyconweb2022/pyconweb2022/urls.py

@@ -16,6 +16,12 @@
 from django.contrib import admin
 from django.urls import path, include
 
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView,
+)
+
 import pyconemailer.routers
 import sponsor.routers
 import program.routers
@@ -30,6 +36,19 @@
     path("api/news/", include("news.urls")),
     path("api/program/", include(program.routers.get_router().urls)),
     path("api/content/", include(content.routers.get_router().urls)),
+    # swagger
+    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",
+    ),
     # PyConEmailer
     path("pyconemailer/", include("pyconemailer.urls")),
     path("api/pyconemailer/", include(pyconemailer.routers.get_router().urls)),

requirements.txt

@@ -15,4 +15,5 @@ Pillow
 boto3
 Werkzeug
 zappa-django-utils
-martor
+martor
+drf-spectacular