Merge pull request #13 from akirachix/feature/swagger

created swagger API documentation for Zeno

Author: Ndichu-shee

api/views.py

@@ -6,10 +6,10 @@
 from django.contrib.auth import authenticate
 from users.models import User, Review
 from agents.models import Agent, Tool
+from runs.models import Run, RunInputFile, RunOutputArtifact 
 from conversations.models import Conversation, Step
 from .serializers import UserSerializer, ReviewSerializer, AgentSerializer, ConversationSerializer, ToolSerializer, StepSerializer, RunInputFileSerializer, RunOutputArtifactSerializer, RunSerializer
 from .permissions import IsAdmin
-from runs.models import Run
 import threading, time, random
 
 class ConversationViewSet(viewsets.ModelViewSet):

requirements.txt

@@ -3,16 +3,18 @@ black==24.8.0
 click==8.1.8
 django==4.2.24
 djangorestframework==3.15.2
+drf-yasg==1.21.10
+inflection==0.5.1
 mypy-extensions==1.1.0
 packaging==25.0
 pathspec==0.12.1
 pillow==10.2.0
 platformdirs==3.4.0
-sqlparse==0.5.3
-typing-extensions==4.13.2
 psycopg==3.2.9
 psycopg2-binary==2.9.10
-whitenoise==6.7.0 
-
-
-
+pytz==2025.2
+pyyaml==6.0.2
+sqlparse==0.5.3
+typing-extensions==4.13.2
+uritemplate==4.1.1
+whitenoise==6.7.0

zeno/settings.py

@@ -43,7 +43,9 @@
     'rest_framework.authtoken',
     'agents',
     'conversations',
-    'runs'
+    'runs',
+    'drf_yasg',
+
 ]
 
 

zeno/urls.py

@@ -1,25 +1,26 @@
-"""
-URL configuration for zeno project.
-
-The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/5.2/topics/http/urls/
-Examples:
-Function views
-    1. Add an import:  from my_app import views
-    2. Add a URL to urlpatterns:  path('', views.home, name='home')
-Class-based views
-    1. Add an import:  from other_app.views import Home
-    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
-Including another URLconf
-    1. Import the include() function: from django.urls import include, path
-    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
-"""
 from django.contrib import admin
-from django.urls import path,include
-from django.conf import settings
+from django.urls import path, include, re_path
+from rest_framework import permissions
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
 
+schema_view = get_schema_view(
+    openapi.Info(
+        title="Zeno AI API",
+        default_version='v1',
+        description="API documentation for Zeno AI - Economic Reasoning System",
+        contact=openapi.Contact(email="support@zenoai.com"),
+        license=openapi.License(name="BSD License"),
+    ),
+    public=True,
+    permission_classes=[permissions.AllowAny],
+)
 
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('api/', include('api.urls')),
-]
+    # --- Swagger and Redoc docs ---
+    re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
+    path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
+    path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
+]