Appendnewrequestexampletodrf-spectacularschema
创始人
2024-09-10 05:00:22
0次

可以'Append new request example to drf-spectacular schema”翻译成“将新的请求示例附加到drf-spectacular模式”,解决方法如下:

示例视图函数:

from drf_spectacular.utils import extend_schema
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.plumbing import build_request_serializer
from rest_framework.decorators import schema

class ExampleView(APIView):
    @extend_schema(
        request=build_request_serializer(
            types={'application/json': OpenApiTypes.OBJECT},
            required=['field1', 'field2'],
            properties={'field1': {'type': 'string', 'example': 'example1'},
                        'field2': {'type': 'integer', 'example': 123}}
        )
    )
    def post(self, request):
        pass

这里使用build_request_serializer来生成请求参数的Schema。在properties参数中,我们可以设置每个属性的类型、描述和示例。

在视图方法上,我们使用@extend_schema来扩展Schema。这里,我们使用了build_request_serializer生成了一个请求参数的Schema,并将其作为请求对象的一部分添加到了扩展的Schema中。

这样,在生成OpenAPI文档时,我们就可以在请求对象的Schema中看到示例参数。

示例输出:

openapi: '3.0.3'
info:
  title: My API
  version: 1.0.0
paths:
  /example/:
    post:
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                field1:
                  type: string
                  example: example1
                field2:
                  type: integer
                  example: 123
              required:
                - field1
                - field2
      responses:
        '200':
          description: ''

在requestBody节点下,我们可以看到请求对象的Schema,其中包含了示例参数

相关内容

热门资讯

专业讨论!wepoker模拟器... wepoker模拟器哪个好用AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏...
重大消息!wpk有那种辅助吗,... 重大消息!wpk有那种辅助吗,WPK有挂吗教程(先前有开挂)AI 智能体黑科技再上新,自动化能力开挂...
推荐几款新版!wepoker底... 您好:wepoker底牌透视这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用...
总算了解!wpk有作弊吗,德普... 总算了解!wpk有作弊吗,德普之星外卦神器软件教程(竟然有开挂)AI 智能体黑科技再上新,自动化能力...
大神推荐!wepoker透视脚... wepoker透视脚本免费AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻...
避坑细节!如何下载德普之星辅助... 『标题:当前标题』主打赛后复盘的 AI 游戏攻略黑科技走红,对局总结能力开挂。上传对局回放或者战绩截...
一分钟了解!!wepoker辅... AI 黑科技赛道又上新,这款智能处理工具堪称效率开挂,专门面向短视频创作者打造。它打通脚本撰写、AI...
玩家科普!wpk真的有透视嘛,... 玩家科普!wpk真的有透视嘛,WPK透视脚本工具(好像存在有辅助挂)AI 智能体黑科技再上新,自动化...
一分钟揭秘!德普之星辅助工具如... 您好:德普之星辅助工具如何打开这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多...
大家学习交流!wepoker游... 您好:wepoker游戏安装教程这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很...