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

相关内容

热门资讯

透明教学!科技实测情怀辅助,w... 您好:科技实测情怀辅助这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的牌...
盘点一款!广东星悦有外开挂辅助... 盘点一款!广东星悦有外开挂辅助器吗,边锋老友威海荣成辅助(有挂开挂辅助挂);亲,广东星悦有外开挂辅助...
透视辅助!钱塘十三水挂件有吗,... 透视辅助!钱塘十三水挂件有吗,wpk透视辅助下载-原生有挂开挂辅助器;无需打开直接搜索加(薇:136...
科普!樱花之盛牛牛挂,茶馆辅助... 科普!樱花之盛牛牛挂,茶馆辅助软件(有挂开挂辅助平台);无需打开直接搜索加薇136704302(咨询...
透明教学!老友广东麻将有没有假... 透明教学!老友广东麻将有没有假,wpk作弊是真的吗-从前有挂开挂辅助下载这是一款可以让一直输的玩家,...
实测发现!心悦游戏万能透视辅助... 实测发现!心悦游戏万能透视辅助器免费,中至余干安装挂(有挂开挂辅助下载);亲,心悦游戏万能透视辅助器...
透视苹果版!杭州都莱辅助软件下... 透视苹果版!杭州都莱辅助软件下载,wepoker透视有没有-往昔有挂开挂辅助神器这是一款可以让一直输...
盘点一款!孝感卡五星辅助,海贝... 海贝之城有辅助吗是一款专注玩家量身打造的游戏记牌类型软件,在海贝之城有辅助吗这款游戏中我们可以记录下...
透视app!闲来贵州黑科技辅助... 透视app!闲来贵州黑科技辅助软件,wepoker有透视底牌吗-原生有挂开挂辅助下载;无需打开直接搜...
玩家交流!胡乐麻将辅助,微乐家... 微乐家乡自建房辅助app是一款可以让一直输的玩家,快速成为一个“必胜”的ai辅助神器,有需要的用户可...