Merge pull request #79 from codersforcauses/issue-75-documenting-APIs

Issue 75 documenting APIs

server/api/quiz/migrations/0006_alter_questionattempt_answer_student.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1 on 2025-01-22 08:33
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("quiz", "0005_questionattempt_student"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="questionattempt",
+            name="answer_student",
+            field=models.IntegerField(default=None),
+        ),
+    ]

server/api/settings.py

@@ -60,6 +60,7 @@
     "api.users",
     "api.quiz",
     "api.team",
+    'drf_spectacular',
 ]
 
 REST_FRAMEWORK = {
@@ -68,6 +69,9 @@
         "rest_framework.authentication.SessionAuthentication",
         "rest_framework.authentication.BasicAuthentication",
     ),
+
+
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
     'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend']
 }
 
@@ -196,3 +200,11 @@
 # https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# DRF Spectacular settings
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'Your Project API',
+    'DESCRIPTION': 'Your project description',
+    'VERSION': '1.0.0',
+    'SERVE_INCLUDE_SCHEMA': False,
+}

server/api/urls.py

@@ -17,6 +17,7 @@
 
 from django.contrib import admin
 from django.urls import include, path
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
 
 urlpatterns = [
     path("admin/", admin.site.urls),
@@ -27,5 +28,10 @@
     path("api/auth/", include("api.auth.urls")),
     path("api/team/", include("api.team.urls")),
     path("api/users/", include("api.users.urls")),
+    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+    # Optional UI:
+    path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+    path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
+
 
 ]

server/api/users/admin.py

@@ -41,6 +41,11 @@ class TeacherAdmin(admin.ModelAdmin):
 class CustomUserAdmin(admin.ModelAdmin):
     inlines = [StudentInline, TeacherInline]
 
+    def save_model(self, request, obj, form, change):
+        if form.cleaned_data["password"]:
+            obj.set_password(form.cleaned_data["password"])
+        super().save_model(request, obj, form, change)
+
 
 admin.site.unregister(User)
 admin.site.register(User, CustomUserAdmin)