Appendnewrequestexampletodrf-spectacularschema
创始人
2024-09-10 05:01:24
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,其中包含了示例参数

相关内容

热门资讯

银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
AWSElasticBeans... 在Dockerfile中手动配置nginx反向代理。例如,在Dockerfile中添加以下代码:FR...
AsusVivobook无法开... 首先,我们可以尝试重置BIOS(Basic Input/Output System)来解决这个问题。...
ASM贪吃蛇游戏-解决错误的问... 要解决ASM贪吃蛇游戏中的错误问题,你可以按照以下步骤进行:首先,确定错误的具体表现和问题所在。在贪...
​ToDesk 远程工具安装及... 目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...