Add drf-yasg as a replacement of deprecated coreapi for API documentation #313

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

dejacode/settings.py

@@ -317,6 +317,7 @@ def gettext_noop(s):
     "django.contrib.admin",
     "rest_framework",
     "rest_framework.authtoken",
+    "drf_yasg",
     "django_rq",
     "crispy_forms",
     "crispy_bootstrap5",
@@ -625,7 +626,6 @@ def get_fake_redis_connection(config, use_strict_redis):
         "user": REST_API_RATE_THROTTLE,
     },
     "DEFAULT_PAGINATION_CLASS": "dje.api_custom.PageSizePagination",
-    "DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.coreapi.AutoSchema",
     "VIEW_NAME_FUNCTION": "dje.api_custom.get_view_name",
     "URL_FIELD_NAME": "api_url",  # Default 'url' used as a field on the Package model
 }

dejacode/urls.py

@@ -10,15 +10,15 @@
 from django.conf.urls import include
 from django.contrib import admin
 from django.contrib.auth import views as auth_views
-from django.contrib.auth.decorators import login_required
 from django.template.loader import render_to_string
 from django.urls import path
 from django.views.defaults import page_not_found
 from django.views.generic import RedirectView
 from django.views.generic import TemplateView
 
+from drf_yasg import openapi
+from drf_yasg.views import get_schema_view
 from notifications.views import mark_all_as_read
-from rest_framework.documentation import include_docs_urls
 from rest_framework.routers import DefaultRouter
 
 from component_catalog.api import ComponentViewSet
@@ -167,22 +167,28 @@
     path("purldb/", include(("purldb.urls", "purldb"))),
 ]
 
-api_docs_urls = include_docs_urls(
-    title="DejaCode REST API",
-    public=False,
-    description=render_to_string(
-        "rest_framework/docs/description.html",
-        context={"site_url": settings.SITE_URL.rstrip("/")},
+api_docs_view = get_schema_view(
+    openapi.Info(
+        title="DejaCode REST API",
+        default_version="v2",
+        description=render_to_string(
+            "rest_framework/docs/description.html",
+            context={"site_url": settings.SITE_URL.rstrip("/")},
+        ),
     ),
+    public=False,
 )
 
-# Force login_required on all API documentation URLs.
-for doc_url in api_docs_urls[0]:
-    doc_url.callback = login_required(doc_url.callback)
+# TODO: Force login_required on all API documentation URLs.
+# for doc_url in api_docs_urls[0]:
+#     doc_url.callback = login_required(doc_url.callback)
+api_docs_patterns = [
+    path("", api_docs_view.with_ui("redoc", cache_timeout=0), name="docs-index"),
+]
 
 urlpatterns += [
     path("api/v2/", include((api_router.urls, "api_v2"))),
-    path("api/v2/docs/", api_docs_urls),
+    path("api/v2/docs/", include((api_docs_patterns, "api-docs"))),
 ]
 
 if settings.ENABLE_SELF_REGISTRATION:

setup.cfg

@@ -70,7 +70,11 @@ install_requires =
     django_altcha==0.1.3
     # REST API
     djangorestframework==3.16.0
-    # API documentation, `coreapi` and its requirements:
+    # API documentation
+    drf-yasg==1.21.10
+    inflection==0.5.1
+    pytz==2025.2
+    # Old API documentation, `coreapi` and its requirements:
     coreapi==2.3.3
     MarkupSafe==3.0.2
     coreschema==0.0.4