The changes made in this commit include:

- Added `rest_framework` and `drf_spectacular` to the `EXTERNAL_APPS` list in `settings.py`.
- Added `PAGE_SIZE` variable to the settings file, which retrieves its value from the `PAGE_SIZE` environment variable or defaults to 10.
- Added Django REST framework settings to the `REST_FRAMEWORK` dictionary in `settings.py`, including pagination class, renderer classes, parser classes, authentication classes, schema class, and filter backends.
- Added DRF Spectacular settings to the `SPECTACULAR_SETTINGS` dictionary in `settings.py`, including title, description, version, component split settings, serve public setting, schema path prefix, Swagger UI settings, and serve include schema setting.
- Imported necessary views from `drf_spectacular.views` in `urls.py`.
- Added URL patterns for DRF Spectacular views in `urls.py`, including the schema view, Swagger UI view, and ReDoc view.

Author: BrainIsDead

src/signal_documentation/settings.py

@@ -10,10 +10,10 @@
 https://docs.djangoproject.com/en/4.2/ref/settings/
 """
 import os
-import sentry_sdk
 from pathlib import Path
 from typing import Any
 
+import sentry_sdk
 # Sentry init and config:
 # - If you want to use Sentry, specify the DSN via the env var of `SENTRY_DSN`.
 # - Useful defaults for a development environment are set below. They can be
@@ -81,6 +81,8 @@
     'debug_toolbar',
     'django_extensions',
     'models_extensions',
+    'rest_framework',
+    'drf_spectacular',
     'django_filters',
     'health_check',
     'health_check.db',
@@ -150,6 +152,54 @@
     }
 }
 
+
+PAGE_SIZE = os.environ.get('PAGE_SIZE', 10)
+
+
+# Django REST framework
+# https://www.django-rest-framework.org/
+REST_FRAMEWORK = {
+    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
+    "PAGE_SIZE": os.environ.get('PAGE_SIZE', PAGE_SIZE),
+    'DEFAULT_RENDERER_CLASSES': [
+        'rest_framework.renderers.JSONRenderer',
+        'rest_framework.renderers.BrowsableAPIRenderer',
+    ],
+    'DEFAULT_PARSER_CLASSES': [
+        'rest_framework.parsers.JSONParser',
+        'rest_framework.parsers.MultiPartParser',
+    ],
+    'DEFAULT_AUTHENTICATION_CLASSES': [
+        'rest_framework.authentication.BasicAuthentication',
+        'rest_framework.authentication.SessionAuthentication',
+    ],
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
+    'DEFAULT_FILTER_BACKENDS': (
+        'django_filters.rest_framework.DjangoFilterBackend',
+    ),
+
+}
+
+
+# DRF Spectacular settings
+# https://drf-spectacular.readthedocs.io/en/latest/settings.html
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'Signal Documentation',
+    'DESCRIPTION': 'Signal Documentation API',
+    'VERSION': '1.0.0',
+    "COMPONENT_SPLIT_PATCH": True,
+    "COMPONENT_SPLIT_REQUEST": True,
+    'SERVE_PUBLIC': True,
+    'SCHEMA_PATH_PREFIX': '/api/v[0-9]',
+    'SWAGGER_UI_SETTINGS': {
+        'docExpansion': 'list',
+        'filter': True,
+        'tagsSorter': 'alpha',
+    },
+    'SERVE_INCLUDE_SCHEMA': False,
+}
+
+
 # Django chache
 # https://docs.djangoproject.com/en/4.2/topics/cache/#redis
 

src/signal_documentation/urls.py

@@ -22,6 +22,11 @@
     include,
     path,
 )
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView,
+)
 
 from base.views import (
     BadRequestErrorView,
@@ -39,6 +44,11 @@
     path(f'{settings.MAIN_PAGE}/admin/' if settings.MAIN_PAGE else 'admin/', admin.site.urls),
     path('__debug__/', include('debug_toolbar.urls')),
     path(f'{settings.MAIN_PAGE}/' if settings.MAIN_PAGE else '', include('signals.urls')),
+
+    # drf-spectacular
+    path("api/docs/schema/", SpectacularAPIView.as_view(), name="spectacular-schema"),
+    path("api/docs/swagger/", SpectacularSwaggerView.as_view(url_name="spectacular-schema"), name="swagger"),
+    path("api/docs/redoc/", SpectacularRedocView.as_view(url_name="spectacular-schema"), name="redoc"),
 ]
 
 urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)  # type: ignore