Swagger UI各参数讲解

参数注释1

parameters 的属性

  • in 定义参数类型,是在 body 中还是 url 中,可选值:body,path,query,formdata
  • description
  • required 是否为必须参数
  • type 参数的数据类型
  • format 定义具体的数据类型
  • default 设置参数默认值
  • item 当 type 是“array”时有用
1
2
3
4
5
6
7
8
type: "array"
items:
type: "string"
enum:
- "available"
- "pending"
- "sold"
default: "available"

Post 请求,body 是字符串数组的定义

1
2
3
4
5
6
7
8
9
10
11
12
13
14
      parameters:
- in: "body"
name: "body"
description: "some urls"
required: true
schema:
type: "array"
items:
$ref: "#/definitions/Urls"


definitions:
Urls:
type: "string"

Urls 是在 definitions 中定义的字符串类型对象,也可以直接在 item 中定义 type

responses 的配置

可以配置写说明,比如 200,400,什么的,如果返回值是个对象,也可以配置返回值对应对象,但是不配置也行,会直接输出出来。

文章作者: wenmu
文章链接: http://blog.wangpengpeng.site/2020/01/09/Swagger-UI%E5%90%84%E5%8F%82%E6%95%B0%E8%AE%B2%E8%A7%A3/
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 温木的博客
微信打赏