keannu125/Borrowing-TrackerBackend
1
0
Fork 0
mirror of https://github.com/lemeow125/Borrowing-TrackerBackend.git synced 2025-04-27 10:11:24 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added schema documentation

Browse source
This commit is contained in:
Keannu Christian Bernasol 2023-11-09 19:52:03 +08:00
parent 1c56369044
commit 2d0e602ba1
14 changed files with 732 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
equipment_tracker/config/__pycache__/__init__.cpython-311.pyc Normal file
View file

Binary file not shown.

BIN
equipment_tracker/config/__pycache__/settings.cpython-311.pyc Normal file
View file

Binary file not shown.

BIN
equipment_tracker/config/__pycache__/urls.cpython-311.pyc Normal file
View file

Binary file not shown.

15
equipment_tracker/config/settings.py
View file

@ -66,6 +66,8 @@ INSTALLED_APPS = [
'rest_framework_simplejwt',
'djoser',
'corsheaders',
'drf_spectacular',
'drf_spectacular_sidecar',
'accounts'
]
@ -125,6 +127,19 @@ REST_FRAMEWORK = {
'user': '1440/min'
},
'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
}
# DRF-Spectacular
SPECTACULAR_SETTINGS = {
'TITLE': 'CITC Equipment Tracker Backend',
'DESCRIPTION': 'An IT Elective 4 Project',
'VERSION': '1.0.0',
'SERVE_INCLUDE_SCHEMA': False,
'SWAGGER_UI_DIST': 'SIDECAR',
'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',
'REDOC_DIST': 'SIDECAR',
# OTHER SETTINGS
}
WSGI_APPLICATION = 'config.wsgi.application'

8
equipment_tracker/config/urls.py
View file

@ -16,8 +16,14 @@ Including another URLconf
"""
from django.contrib import admin
from django.urls import path, include
from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
urlpatterns = [
path('admin/', admin.site.urls),
path('api/v1/', include('api.urls'))
path('api/v1/', include('api.urls')),
path('schema/', SpectacularAPIView.as_view(), name='schema'),
path('swagger/',
SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
path('redoc/',
SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
]