drf-yasg如何通过api显示示例响应?

问题描述

如何使用example responses -- (openapi doc)软件包将drf-yasg添加到我的草率文档?

解决方法

drf_yasg.openapi.Response--(drf-yasg doc)装饰器的帮助下,将@swagger_auto_schema(...)--(drf-yasg doc)用作

from drf_yasg.utils import swagger_auto_schema
from drf_yasg import openapi
from rest_framework.response import Response
from rest_framework.views import APIView

response_schema_dict = {
    "200": openapi.Response(
        description="custom 200 description",examples={
            "application/json": {
                "200_key1": "200_value_1","200_key2": "200_value_2",}
        }
    ),"205": openapi.Response(
        description="custom 205 description",examples={
            "application/json": {
                "205_key1": "205_value_1","205_key2": "205_value_2",}


class MyTestAPIView(APIView):

    @swagger_auto_schema(responses=response_schema_dict)
    def post(self,request,*args,**kwargs):
        return Response({"foo": "bar"})

架构呈现的结果

Schema rendered Result

更新

它不断加载,什么也没显示

如果您要查看 Swagger 文档,则可能需要单击 “示例值” 文本

loading spinner