flasgger 描述post 请求中的data json

原创已于 2022-04-20 11:10:17 修改 · 981 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#flask

于 2022-04-20 09:55:26 首次发布

实用工具同时被 2 个专栏收录

5 篇文章

订阅专栏

flask

1 篇文章

订阅专栏

本文指导如何在Flasgger文档中准确描述POST请求的JSON数据结构，包括必需参数、数据类型及使用OAI-2.0规范。通过实例解析参数定义和MIME类型，助您创建清晰易用的API文档。

flasgger 的post 请求描述

描述post 请求中的 data json
- 参考自

描述post 请求中的 data json

接口函数下面的注释请求描述如下:

'''
    接收含有所需信息的JSON请求并返回结果

    ---
    tags:
      - xxAPI
    summary: get post json data return xxx 
    description: "xxxxxxxx"
    operationId: layoutApi

    consumes:
        - application/json
    produces:
        - application/json
    parameters:
        - name: data
          in: body
          description: The data JSON you want to post
          schema:  # <--- What do I write here?
          required: true
'''

部分字段说明如下（完整详细信息可见:https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md）:

字段名称	类型	说明
consumes	[string]	API 可以消费(收到请求)的Mime Types 列表
produces	[string]	API 可以产生(返回结果)的Mime Types 列表
parameters	Parameters Definitions Object	参数对象