drf_spectacular_openapi_schema_quickstart_django_settings_urls.py

1# 1. Standard Django settings.py requirements
2INSTALLED_APPS = [
3    # ...
4    'rest_framework',
5    'drf_spectacular',
6    # ...
7]
8
9REST_FRAMEWORK = {
10    # YOUR SETTINGS
11    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
12}
13
14SPECTACULAR_SETTINGS = {
15    'TITLE': 'Your Project API',
16    'DESCRIPTION': 'Your project description',
17    'VERSION': '1.0.0',
18    'SERVE_INCLUDE_SCHEMA': False,
19    # OTHER SETTINGS
20}
21
22# 2. In your urls.py
23from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
24from django.urls import path
25
26urlpatterns = [
27    # YOUR PATTERNS
28    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
29    # Optional UI:
30    path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
31    path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
32]