更新admin 和 swagger

This commit is contained in:
jeremygan2021
2026-02-02 14:41:21 +08:00
parent c93bf9ef11
commit 529a0d8b1d
4 changed files with 17 additions and 6 deletions

View File

@@ -42,6 +42,7 @@ INSTALLED_APPS = [
'rest_framework', 'rest_framework',
'corsheaders', 'corsheaders',
'drf_spectacular', # Swagger文档生成 'drf_spectacular', # Swagger文档生成
'drf_spectacular_sidecar',
'shop', 'shop',
] ]
@@ -150,12 +151,9 @@ SPECTACULAR_SETTINGS = {
'SERVE_INCLUDE_SCHEMA': True, 'SERVE_INCLUDE_SCHEMA': True,
'SERVE_PERMISSIONS': ['rest_framework.permissions.AllowAny'], 'SERVE_PERMISSIONS': ['rest_framework.permissions.AllowAny'],
'COMPONENT_SPLIT_REQUEST': True, 'COMPONENT_SPLIT_REQUEST': True,
'SCHEMA_PATH_PREFIX': r'/api/v[0-9]', 'SWAGGER_UI_DIST': 'SIDECAR',
'SWAGGER_UI_SETTINGS': { 'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',
'deepLinking': True, 'REDOC_DIST': 'SIDECAR',
'persistAuthorization': True,
'displayOperationId': True,
},
} }
# django-unfold配置 # django-unfold配置

View File

@@ -2,9 +2,14 @@ from rest_framework import viewsets, status
from rest_framework.decorators import action from rest_framework.decorators import action
from rest_framework.response import Response from rest_framework.response import Response
from django.shortcuts import render from django.shortcuts import render
from drf_spectacular.utils import extend_schema, extend_schema_view, OpenApiParameter, OpenApiExample
from .models import ESP32Config, Order, WeChatPayConfig, Service, ARService, ServiceOrder from .models import ESP32Config, Order, WeChatPayConfig, Service, ARService, ServiceOrder
from .serializers import ESP32ConfigSerializer, OrderSerializer, ServiceSerializer, ARServiceSerializer, ServiceOrderSerializer from .serializers import ESP32ConfigSerializer, OrderSerializer, ServiceSerializer, ARServiceSerializer, ServiceOrderSerializer
@extend_schema_view(
list=extend_schema(summary="获取AR服务列表", description="获取所有可用的AR服务"),
retrieve=extend_schema(summary="获取AR服务详情", description="获取指定AR服务的详细信息")
)
class ARServiceViewSet(viewsets.ReadOnlyModelViewSet): class ARServiceViewSet(viewsets.ReadOnlyModelViewSet):
""" """
AR服务列表和详情 AR服务列表和详情
@@ -21,6 +26,10 @@ def order_check_view(request):
""" """
return render(request, 'shop/order_check.html') return render(request, 'shop/order_check.html')
@extend_schema_view(
list=extend_schema(summary="获取AI服务列表", description="获取所有可用的AI服务"),
retrieve=extend_schema(summary="获取AI服务详情", description="获取指定AI服务的详细信息")
)
class ServiceViewSet(viewsets.ReadOnlyModelViewSet): class ServiceViewSet(viewsets.ReadOnlyModelViewSet):
""" """
AI服务列表和详情 AI服务列表和详情
@@ -35,6 +44,10 @@ class ServiceOrderViewSet(viewsets.ModelViewSet):
queryset = ServiceOrder.objects.all() queryset = ServiceOrder.objects.all()
serializer_class = ServiceOrderSerializer serializer_class = ServiceOrderSerializer
@extend_schema_view(
list=extend_schema(summary="获取ESP32配置列表", description="获取所有可用的ESP32硬件配置选项"),
retrieve=extend_schema(summary="获取ESP32配置详情", description="获取指定ESP32配置的详细信息")
)
class ESP32ConfigViewSet(viewsets.ReadOnlyModelViewSet): class ESP32ConfigViewSet(viewsets.ReadOnlyModelViewSet):
""" """
提供ESP32配置选项的列表和详情 提供ESP32配置选项的列表和详情