mirror of
https://github.com/Dispatcharr/Dispatcharr.git
synced 2026-07-17 16:50:53 +00:00
- Swagger/OpenAPI Migration: Migrated from drf-yasg (OpenAPI 2.0) to drf-spectacular (OpenAPI 3.0) for API documentation. This provides:
- Native Bearer token authentication support in Swagger UI - users can now enter just the JWT token and the "Bearer " prefix is automatically added - Modern OpenAPI 3.0 specification compliance - Better auto-generation of request/response schemas - Improved documentation accuracy with serializer introspection
This commit is contained in:
parent
8616933ad7
commit
5364123745
11 changed files with 290 additions and 479 deletions
|
|
@ -32,7 +32,7 @@ INSTALLED_APPS = [
|
|||
"apps.vod.apps.VODConfig",
|
||||
"core",
|
||||
"daphne",
|
||||
"drf_yasg",
|
||||
"drf_spectacular",
|
||||
"channels",
|
||||
"django.contrib.admin",
|
||||
"django.contrib.auth",
|
||||
|
|
@ -151,7 +151,7 @@ AUTH_PASSWORD_VALIDATORS = [
|
|||
]
|
||||
|
||||
REST_FRAMEWORK = {
|
||||
"DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.coreapi.AutoSchema",
|
||||
"DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
|
||||
"DEFAULT_RENDERER_CLASSES": [
|
||||
"rest_framework.renderers.JSONRenderer",
|
||||
"rest_framework.renderers.BrowsableAPIRenderer",
|
||||
|
|
@ -162,10 +162,22 @@ REST_FRAMEWORK = {
|
|||
"DEFAULT_FILTER_BACKENDS": ["django_filters.rest_framework.DjangoFilterBackend"],
|
||||
}
|
||||
|
||||
SWAGGER_SETTINGS = {
|
||||
"SECURITY_DEFINITIONS": {
|
||||
"Bearer": {"type": "apiKey", "name": "Authorization", "in": "header"}
|
||||
}
|
||||
SPECTACULAR_SETTINGS = {
|
||||
"TITLE": "Dispatcharr API",
|
||||
"DESCRIPTION": "API documentation for Dispatcharr",
|
||||
"VERSION": "1.0.0",
|
||||
"SERVE_INCLUDE_SCHEMA": False,
|
||||
"SECURITY": [{"BearerAuth": []}],
|
||||
"COMPONENTS": {
|
||||
"securitySchemes": {
|
||||
"BearerAuth": {
|
||||
"type": "http",
|
||||
"scheme": "bearer",
|
||||
"bearerFormat": "JWT",
|
||||
"description": "Enter your JWT access token. The 'Bearer ' prefix is added automatically.",
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
LANGUAGE_CODE = "en-us"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue