首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何自定义drf-yasg端点的示例响应?

如何自定义drf-yasg端点的示例响应?
EN

Stack Overflow用户
提问于 2022-07-21 11:26:38
回答 1查看 279关注 0票数 2

在我的Django项目中,我使用DRF和drf-yasg。在某些端点,示例响应体显示不正确的示例。如以下示例所示:

但是其中一些没有显示正确的响应体示例。

这个端点实际上返回access_token和refresh_token,不返回电子邮件和密码。这对前端开发人员来说是错误的信息。有什么办法来改变这个吗?

EN

回答 1

Stack Overflow用户

发布于 2022-11-01 21:21:32

下面是一个使用带有3个序列化器的@swagger_auto_schema注释的示例。1个请求序列化程序和2个响应序列化程序(成功和错误序列化程序)。

代码语言:javascript
复制
class RequestSerializer(serializers.Serializer):
   param = serializers.CharField()

                  
class SucessSerializer(serializers.Serializer):
   success = serializers.BooleanField()
   message = serializers.CharField()

                     
class ErrorSerializer(serializers.Serializer):
   success = serializers.BooleanField()
   errors = serializers.IntegerField()

代码语言:javascript
复制
class ExampleViewView(APIView):

    @swagger_auto_schema(
        request_body = RequestSerializer,
        responses={
            '200': SucessSerializer,
            '500': ErrorSerializer,
        },
        operation_description = 'Doc description'
    )
    def post(self, request):
        
        return successResponse({
            'sucess': True
        })
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/73065335

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档