feat: enable API docs UI

Author: SHINTEKI

django_project/settings/base.py

@@ -47,9 +47,22 @@
     'pangenome_analyses',
     'gene_function',
     'search',
-    'ai_assistant'
+    'ai_assistant',
+    'drf_spectacular',
+    'rest_framework',
 ]
 
+REST_FRAMEWORK = {
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
+}
+
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'PanKB Developer API',
+    'DESCRIPTION': 'API documentation for PanKB.',
+    'VERSION': '1.0.0',
+    'SERVE_INCLUDE_SCHEMA': True,
+}
+
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',

django_project/urls.py

@@ -16,6 +16,7 @@
 
 from django.urls import path
 from django.views.generic import TemplateView
+from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
 
 from home import views as home_views
 from about import views as about_views
@@ -191,6 +192,8 @@
     path("interop-query/genes", interop_views.genes, name="genes"),
     path("interop-query/strains", interop_views.strains, name="strains"),
     path("interop-query/gene-strain-pairs", interop_views.gene_strain_pairs, name="gene_strain_pairs"),
-
+    
+    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+    path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
     # path('admin/', admin.site.urls)   # make the amdin panel inaccessible via its utl (the admin admin is preserved for the potential future needs)
 ]