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,其中包含了示例参数

相关内容

热门资讯

透视免费!wpk俱乐部辅助器,... 透视免费!wpk俱乐部辅助器,wpk插件辅助,科技教程(有挂揭秘)1、每一步都需要思考,不同水平的挑...
透视游戏!wpk真吗,wpk透... 透视游戏!wpk真吗,wpk透视怎么安装,科技教程(有挂规律)1、金币登录送、破产送、升级送、活动送...
透视美元局!wpk有辅助器吗,... 透视美元局!wpk有辅助器吗,wpk德州局透视,规律教程(有挂黑科技)运wpk德州局透视辅助工具,进...
透视好友房!wpk俱乐部是真的... 透视好友房!wpk俱乐部是真的吗,wpk安卓下载辅助,解说技巧(有挂黑科技)1、让任何用户在无需wp...
透视最新!如何下载wpk透视版... 透视最新!如何下载wpk透视版,wpk私人辅助,详细教程(有挂脚本)如何下载wpk透视版软件透明挂微...
透视私人局!wpk有那种辅助吗... 透视私人局!wpk有那种辅助吗,wpk俱乐部有没有辅助,专业教程(有挂教程)1、wpk俱乐部有没有辅...
透视了解!wpk模拟器是什么,... 透视了解!wpk模拟器是什么,wpk模拟器是什么,爆料教程(有挂细节);1、进入游戏-大厅左侧-新手...
辅助透视!wpk插件,wpk透... 辅助透视!wpk插件,wpk透视辅助靠谱吗,攻略教程(有挂细节);所有人都在同一条线上,像星星一样排...
透视科技!wpk控制牌是真的吗... 透视科技!wpk控制牌是真的吗,wpk透视辅助,规律教程(有挂技巧);1、超多福利:超高返利,海量正...
透视辅助!wpk作弊是真的吗,... 透视辅助!wpk作弊是真的吗,wpk私人局有透视吗,安装教程(有挂插件);1、wpk私人局有透视吗透...