Swagger如果使用得当,生成文档还是比较容易看明白,如果说明的不好,还不如普通文档。所以,有些用法还是值得记录下:
- 对Controller的说明,加上tags说明controller是某方面的接口,如
文档的显示为:
2.复杂的参数,比如我们请求的参数是一个对象,就使用@ApiModelProperty进行说明:
显示的信息为:
3. 数组里面包含对象
这里有坑,且看我的:
(1)在实体类上添加ApiModel说明,类似如下:
(2)请求的参数加上@RequestBody,否则不会有效果,坑就坑在这
显示的信息为:
4. 屏蔽某个字段,某个字段不需要显示在文档,要不然前端搞不清楚,使用hidden = true