Swagger如果使用得当,生成文档还是比较容易看明白,如果说明的不好,还不如普通文档。所以,有些用法还是值得记录下:

  1. 对Controller的说明,加上tags说明controller是某方面的接口,如

Swagger的几种高级用法
文档的显示为:
Swagger的几种高级用法
2.复杂的参数,比如我们请求的参数是一个对象,就使用@ApiModelProperty进行说明:

Swagger的几种高级用法显示的信息为:
Swagger的几种高级用法
3. 数组里面包含对象

这里有坑,且看我的:

(1)在实体类上添加ApiModel说明,类似如下:

Swagger的几种高级用法

(2)请求的参数加上@RequestBody,否则不会有效果,坑就坑在这

Swagger的几种高级用法显示的信息为:

Swagger的几种高级用法4. 屏蔽某个字段,某个字段不需要显示在文档,要不然前端搞不清楚,使用hidden = true

Swagger的几种高级用法

相关文章:

  • 2020-03-31
  • 2021-07-19
  • 2021-12-09
  • 2021-08-07
  • 2022-12-23
  • 2021-05-21
  • 2021-06-28
猜你喜欢
  • 2022-12-23
  • 2022-12-23
  • 2021-05-12
  • 2022-12-23
  • 2021-10-16
相关资源
相似解决方案