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

相关内容

热门资讯

解密关于!情怀莆仙辅助,小闲辅... 解密关于!情怀莆仙辅助,小闲辅助软件(有挂开挂辅助软件);无需打开直接搜索加薇136704302(咨...
透明挂透视!功夫川麻小程序辅助... 透明挂透视!功夫川麻小程序辅助器,wepoker有辅助功能吗-最初有挂开挂辅助平台;无需打开直接搜索...
推荐一款!老友广东麻将有没有假... 推荐一款!老友广东麻将有没有假,悟空大厅辅助助手下载安装(有挂开挂辅助安装);无需打开直接搜索加薇1...
透视黑科技!白金岛辅助怎么设置... 透视黑科技!白金岛辅助怎么设置,云扑克有透视吗-原本有挂开挂辅助软件1、下载安装好白金岛辅助怎么设置...
实测必看!传送屋有没有挂,情怀... 实测必看!传送屋有没有挂,情怀打七开辅助(有挂开挂辅助神器);无需打开直接搜索薇:136704302...
透明教程!吉祥填大坑的破解方法... 透明教程!吉祥填大坑的破解方法,hhpoker免费辅助器-原生有挂开挂辅助插件;无需打开直接搜索加薇...
玩家必用!兴动互娱游戏辅助怎么... 玩家必用!兴动互娱游戏辅助怎么用,红茶馆app辅助(有挂开挂辅助器);无需打开直接搜索加薇13670...
透明工具!花花生活圈是不是有挂... 您好:花花生活圈是不是有挂这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户...
玩家必看教程!广东雀伸辅助器,... 您好:广东雀伸辅助器这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的牌特...
透明挂透视!广东雀神透视,哈糖... 透明挂透视!广东雀神透视,哈糖大菠萝攻略-原先有挂开挂辅助挂;无需打开直接搜索薇:136704302...