drf-yasg 如何使用 api 顯示示例響應？

Question

如何使用drf-yasg包將示例響應（openapi doc）添加到我的 swagger 文檔中？

Answer 1

使用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"})

架構呈現結果

更新

它繼續加載並且不顯示任何內容

如果您正在查看Swagger文檔，則可能需要單擊“示例值”文本

Answer 2

針對@JPG 的回復，有一個快速解決方案。 轉到設置並添加它。

SWAGGER_SETTINGS = {
    "DEFAULT_MODEL_RENDERING": "example"
}

這將首先呈現示例。