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

相关内容

热门资讯

热门推荐!微信小程序多功能辅助... 热门推荐!微信小程序多功能辅助,盛世辅助器,详细app(有挂神器)1、实时微信小程序多功能辅助透视辅...
最新技巧!黑科技微乐小程序辅助... 最新技巧!黑科技微乐小程序辅助器免费,随意玩工具箱辅助器,详细教程(真是有挂)1、点击下载安装,黑科...
盘点十款!乐乐围棋入门辅助,小... 盘点十款!乐乐围棋入门辅助,小程序游戏赴沪期,详细app(有挂教学)1、首先打开小程序游戏赴沪期辅助...
实操分享!新超凡手游辅助,雀友... 实操分享!新超凡手游辅助,雀友会广东潮汕麻雀万能辅助器,详细挂(有挂教程)1、全新机制【雀友会广东潮...
一起来探讨!纳祥游戏脚本,微信... 一起来探讨!纳祥游戏脚本,微信小程序辅助工具,详细攻略(有挂解惑)1、这是跨平台的微信小程序辅助工具...
一分钟揭秘!新八戒辅助,挂是真... 一分钟揭秘!新八戒辅助,挂是真的假的,详细器(确实有挂)1、全新机制【挂是真的假的ai辅助工具激活码...
最新通报!微信小程序微乐房间怎... 最新通报!微信小程序微乐房间怎么开挂,打哈儿床将辅助最新,详细软件(有挂技巧)1、全新机制【微信小程...
玩家实测!欢乐达人暗堡破解,赣... 您好,欢乐达人暗堡破解这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很多玩...
一分钟揭秘!情怀手机麻将辅助器... 一分钟揭秘!情怀手机麻将辅助器,功夫川麻辅助,详细工具(详细教程)1、金币登录送、破产送、升级送、活...
今日科普!微信广东雀神挂件辅助... 今日科普!微信广东雀神挂件辅助,对战互娱辅助系统,详细神器(有挂规律);1、下载好微信广东雀神挂件辅...