Merge pull request #59 from Alschn/feature/websockets-docs

Install drf-spectacular-websocket and add minimal websockets documentation
Alschn · Jun 7, 2024 · 6dcb258 · 6dcb258
2 parents d0f41d0 + 0d47f95
commit 6dcb258
Show file tree

Hide file tree

Showing 4 changed files with 163 additions and 96 deletions.
diff --git a/backend/Pipfile b/backend/Pipfile
@@ -24,17 +24,18 @@ channels-redis = "==4.2.0"
 redis = "==5.0.4"
 django-q2 = "==1.6.2"
 python-dotenv = "==1.0.1"
-psycopg = {extras = ["binary"], version = "==3.1.18"}
+psycopg = { extras = ["binary"], version = "==3.1.18" }
 dj-database-url = "==2.1.0"
 whitenoise = "==6.6.0"
 daphne = "==4.1.2"
 gunicorn = "==22.0.0"
 openpyxl = "==3.1.2"
-drf-spectacular = "==0.27.2"
+drf-spectacular = { extras = ["sidecar"], version = "==0.27.2" }
 django-storages = "==1.14.2"
 boto3 = "==1.34.93"
 django-countries = "==7.6.1"
 drf-standardized-errors = "==0.13.0"
+drf-spectacular-websocket = "==1.2.7"
 
 [dev-packages]
 coverage = "==7.5.0"

diff --git a/backend/Pipfile.lock b/backend/Pipfile.lock
diff --git a/backend/core/settings/base.py b/backend/core/settings/base.py
@@ -68,7 +68,9 @@
     # social auth
     'allauth.socialaccount.providers.google',
     # open api schema
+    'drf_spectacular_websocket',
     'drf_spectacular',
+    'drf_spectacular_sidecar',
     # standardized errors
     'drf_standardized_errors',
     # apps
@@ -332,6 +334,11 @@
         'ErrorCode429Enum': 'drf_standardized_errors.openapi_serializers.ErrorCode429Enum.choices',
         'ErrorCode500Enum': 'drf_standardized_errors.openapi_serializers.ErrorCode500Enum.choices',
     },
+
+    'SWAGGER_UI_SETTINGS': {
+        # https://github.com/Friskes/drf-spectacular-websocket?tab=readme-ov-file#configure-settings
+        'connectSocket': False,
+    }
 }
 
 # Static files (CSS, JavaScript, Images)