Merge pull request #19 from City-of-Helsinki/atv-68/add-swagger-documentation

ATV-68 | Add Swagger documentation for the live functionalities

Author: a-rmz

atv/settings.py

@@ -44,6 +44,7 @@
     API_KEY_CUSTOM_HEADER=(str, "HTTP_X_API_KEY"),
     FIELD_ENCRYPTION_KEYS=(list, []),
     ENABLE_AUTOMATIC_ATTACHMENT_FILE_DELETION=(bool, True),
+    ENABLE_SWAGGER_UI=(bool, True),
 )
 if os.path.exists(env_file):
     env.read_env(env_file)
@@ -118,6 +119,7 @@
     "corsheaders",
     "encrypted_fields",
     "guardian",
+    "drf_spectacular",
     # Local apps
     "users",
     "services",
@@ -159,7 +161,9 @@
 REST_FRAMEWORK = {
     "DEFAULT_PERMISSION_CLASSES": [
         "rest_framework.permissions.IsAdminUser",
-    ]
+    ],
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+    "DEFAULT_PARENT_LOOKUP_KWARG_NAME_PREFIX": "",
 }
 
 ATTACHMENT_MEDIA_DIR = "attachments"
@@ -193,6 +197,15 @@
 if not DEBUG and DEBUG_FIELD_ENCRYPTION_KEY in FIELD_ENCRYPTION_KEYS:
     raise ImproperlyConfigured("Cannot use the debug encryption key in production")
 
+# API Documentation
+ENABLE_SWAGGER_UI = env("ENABLE_SWAGGER_UI")
+
+SPECTACULAR_SETTINGS = {
+    "TITLE": " Asiointitietovaranto ",
+    "DESCRIPTION": "Asiointitietovaranto REST API",
+    "VERSION": "0.0.1",
+}
+
 LOGGING = {
     "version": 1,
     "disable_existing_loggers": False,

atv/urls.py

@@ -1,6 +1,12 @@
+from django.conf import settings
 from django.contrib import admin
 from django.http import HttpResponse
 from django.urls import include, path
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView,
+)
 from rest_framework_extensions.routers import ExtendedSimpleRouter
 
 from documents.api import AttachmentViewSet, DocumentViewSet
@@ -11,7 +17,7 @@
     r"attachments",
     AttachmentViewSet,
     basename="documents-attachments",
-    parents_query_lookups=["document"],
+    parents_query_lookups=["document_id"],
 )
 
 
@@ -21,9 +27,26 @@
 ]
 
 
+if settings.ENABLE_SWAGGER_UI:
+    urlpatterns += [
+        path("v1/schema/", SpectacularAPIView.as_view(), name="schema"),
+        path(
+            "v1/schema/swagger/",
+            SpectacularSwaggerView.as_view(url_name="schema"),
+            name="swagger",
+        ),
+        path(
+            "v1/schema/redoc/",
+            SpectacularRedocView.as_view(url_name="schema"),
+            name="redoc",
+        ),
+    ]
+
 #
 # Kubernetes liveness & readiness probes
 #
+
+
 def healthz(*args, **kwargs):
     return HttpResponse(status=200)
 

documents/api/__init__.py

@@ -0,0 +1,6 @@
+from .viewsets import AttachmentViewSet, DocumentViewSet
+
+__all__ = [
+    "AttachmentViewSet",
+    "DocumentViewSet",
+]