目录
- 1、springboot+swagger2+knif4j
- 2、springboot+swagger3+knif4j
- 3、springcloud+swagger2+knif4j
1、springboot+swagger2+knif4j
2、springboot+swagger3+knif4j
3、springcloud+swagger2+knif4j
注意点:
- @Api注解:Controller类上的@Api注解需要添加tags属性,否则在UI页面上无法正常显示中文描述信息,写法举例:
@Api(value = "测试", tags = {"测试"})
- 尽量不使用Lombok的@Data注解来标注添加@ApiModel注解的类:该注解将导致swagger在处理字段名称为
uId
这种驼峰写法时,将在swagger或者knife4j的UI页面上显示uid
,但是自己重写set和get方法就不会出现该问题。详细解释请看:swagger接口文档将部分参数转为错误格式驼峰命名 - 项目启动时出现
Failed to start bean ‘documentationPluginsBootstrapper‘; nested exception is java.lang.NullPoi
,这是由于springboot版本大于等于2.6.X了,大家可以降低springboot版本,也可以通过在application.yml中添加配置以及其他配置类方式来解决该问题(下面给出的demo项目使用该方式)。详细解释请看:解决方案之‘Failed to start bean ‘documentationPluginsBootstrapper‘; nested exception is java.lang.NullPoi
说明: 不太想用代码来描述了,下面demo代码,大家可以自取
下载:
链接:https://pan.baidu.com/s/15FsOaMd0CUb4CSRnSG370g?pwd=vgl4
提取码:vgl4
项目结构截图:
swagger和knife4j访问地址信息在每个模块的说明文档.txt
中