如何在DRF-YASG for DRF和DJANGO中消除swagger-ui中id路径参数_Django 2.x drf-yasg如何在自定义方法中创建API (如swagger) - 腾讯云开发者社区

在Django REST Framework (DRF) 结合 drf-yasg (Yet Another Swagger Generator) 生成Swagger文档时，如果你想要在Swagger UI中消除id路径参数，可以通过自定义序列化器（Serializer）和视图（View）的方式来实现。

基础概念

DRF: Django REST Framework 是一个用于构建Web API的强大且灵活的工具包。
drf-yasg: 是一个用于自动生成OpenAPI文档（以前称为Swagger文档）的库。
Swagger UI: 是一个用于与OpenAPI规范定义的API进行交互的用户界面。

类型与应用场景

序列化器（Serializer）: 用于将复杂的数据类型转换为Python数据类型，以便它们可以轻松地渲染成JSON等格式。
视图（View）: 处理HTTP请求并返回响应。

解决问题的方法

自定义序列化器

创建一个自定义的序列化器，排除id字段：

from rest_framework import serializers
from .models import YourModel

class YourModelSerializerWithoutId(serializers.ModelSerializer):
    class Meta:
        model = YourModel
        fields = '__all__'  # 或者指定需要的字段列表，排除'id'
        extra_kwargs = {
            'id': {'read_only': True, 'write_only': True}
        }

自定义视图

在视图中使用这个自定义序列化器：

from rest_framework import viewsets
from .models import YourModel
from .serializers import YourModelSerializerWithoutId

class YourModelViewSet(viewsets.ModelViewSet):
    queryset = YourModel.objects.all()
    serializer_class = YourModelSerializerWithoutId

配置drf-yasg

确保在drf-yasg的配置中排除id参数：

from drf_yasg.views import get_schema_view
from drf_yas克generators import OpenAPISchemaGenerator
from rest_framework import permissions

schema_view = get_schema_view(
    openapi.Info(
        title="Your API",
        default_version='v1',
    ),
    public=True,
    permission_classes=(permissions.AllowAny,),
    generator_class=OpenAPISchemaGenerator,
    patterns=[path('your-api/', YourModelViewSet.as_view({'get': 'list'}), name='your-api-list')],
)