如何在OpenAPI 2.0(Swagger 2.0)中拥有多个身体参数？

mfuanj7w  于 2022-11-06  发布在  其他
关注(0)|答案(1)|浏览(230)

我想在请求体中有多个参数，如下所示，但Swagger编辑器说“不允许有多个体参数”。如何在一个POST体中同时拥有对象和原语类型？
我期待criteria对象和两个原语字段（offset、limit），如下所示：

  1. {
  2.         "criteria": {
  3.             "key": "CBC",
  4.             "code":
  5.         },
  6.         "offset": 5,
  7.         "limit" : 5
  8.     }

OpenAPI定义：

  1. "paths": {
  2.         "/user": {
  3.           "post": {
  4.             "tags": [
  5.               "user Service"
  6.             ],
  7.             "summary": "Returns a list of user",
  8.             "operationId": "searchUsers",
  9.             "produces": [
  10.               "application/json"
  11.             ],
  12.             "parameters": [
  13.               {
  14.                 "in": "body",
  15.                 "name": "criteria",
  16.                 "required": true,
  17.                 "schema": {
  18.                   "$ref": "#/definitions/Criteria"
  19.                 }
  20.               },
  21.               {
  22.                 "name": "offset",
  23.                 "type": "integer",
  24.                 "description": "The offset for pagination.",
  25.                 "format": "int32",
  26.                 "default": 0,
  27.                 "minimum": 0,
  28.                 "required": false,
  29.                 "in": "body"
  30.               },
  31.               {
  32.                 "name": "limit",
  33.                 "type": "integer",
  34.                 "description": "The maximum number user",
  35.                 "format": "int32",
  36.                 "minimum": 1,
  37.                 "maximum": 30,
  38.                 "default": 30,
  39.                 "required": false,
  40.                 "in": "body"
  41.               }
  42.             ],
  43.             "responses": {
  44.               "200": {
  45.                 "description": "Success",
  46.                 "schema": {
  47.                   "$ref": "#/definitions/user"
  48.                 }
  49.               },
  51. definitions:
  52. "Criteria": {
  53.       "type": "object",
  54.       "required": [
  55.         "key"
  56.       ],
  57.       "properties": {
  58.         "key": {
  59.           "type": "string",
  60.           "description": "search key.",
  61.           "pattern": "[A-Za-z0-9-]+",
  62.           "minLength": 1,
  63.           "maxLength": 30
  64.         },
  65.         "code": {
  66.           "type": "string",
  67.           "description": "emp code filter on.",
  68.           "pattern": "^[A-Za-z0-9]+",
  69.           "minLength": 0,
  70.           "maxLength": 9
  71.         }
  73.       }
  74.     },

如何同时保持对象类型和基元类型？

swagger

1条答案

按热度按时间
6yoyoihd

6yoyoihd1#

你就快到了
这一部分介绍了如何在OpenAPI 2.0中定义请求主体：

  1. "parameters": [
  2.               {
  3.                 "in": "body",
  4.                 "name": "criteria",
  5.                 "required": true,
  6.                 "schema": {
  7.                   "$ref": "#/definitions/Criteria"
  8.                 }
  9.               },

也就是说，它被定义为一个in: body参数，但是schema必须描述 * 整个请求主体对象 *，而不是单个字段。
正确的版本是：

  1. "paths": {
  2.     "/user": {
  3.       "post": {
  4.         ...
  6.         "parameters": [
  7.           {
  8.             "in": "body",
  9.             "name": "criteria",
  10.             "required": true,
  11.             "schema": {
  12.               "$ref": "#/definitions/UserSearchParams"
  13.             }
  14.           }
  15.         ],
  16.         "responses": {
  17.           ...
  18.         }
  19.       }
  20.     }
  21.   },
  23.   "definitions": {
  25.     "UserSearchParams": {
  26.       "type": "object",
  27.       "properties": {
  28.         "criteria": {
  29.           "$ref": "#/definitions/Criteria"
  30.         },
  31.         "offset": {
  32.           "type": "integer",
  33.           "description": "The offset for pagination.",
  34.           "format": "int32",
  35.           "default": 0,
  36.           "minimum": 0
  37.         },
  38.         "limit": {
  39.           "type": "integer",
  40.           "description": "The maximum number user",
  41.           "format": "int32",
  42.           "minimum": 1,
  43.           "maximum": 30,
  44.           "default": 30
  45.         }
  46.       }
  47.     },
  49.     "Criteria": {
  50.       "type": "object",
  51.       "required": [
  52.         "key"
  53.       ],
  54.       "properties": {
  55.         "key": {
  56.           "type": "string",
  57.           "description": "search key.",
  58.           "pattern": "[A-Za-z0-9-]+",
  59.           "minLength": 1,
  60.           "maxLength": 30
  61.         },
  62.         "code": {
  63.           "type": "string",
  64.           "description": "emp code filter on.",
  65.           "pattern": "^[A-Za-z0-9]+",
  66.           "minLength": 0,
  67.           "maxLength": 9
  68.         }
  69.       }
  70.     },
  72.     ...
  73.   }
  74. }
展开查看全部
赞(0）分享  回复(0）举报  2022-11-06
我来回答

相关问题

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新问答

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com