1.添加依赖
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2.properties添加以下配置
swagger.enable=true
3.新增spring configuration配置API生成策略
/**
* swagger接口生成策略
*/
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
@Bean
public Docket api() {
return new Docket(DocumentationType.OAS_30)
.select()
// 只有ApiOperation注解的接口才生成文档
.apis(handler -> RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class).test(handler))
.paths(PathSelectors.any())
.build();
}
}
4.调整需要生成接口的代码
- 在需要生成文档的Resource方法添加以下注解
-
class YourResourceImpl { @Override @ApiOperation("测试") public String<xxBean> selectPagination(WrapperBean wrapper){ return "测试"; } }
5.在对应的Bean的字段标注含义
class YourBean {
@Id
@ApiModelProperty("主键")
private Long id;// 主键
}
6.可在IDEA使用以下正则替换,将字段注释添加为ApiModelProperty
# 匹配正则
(\s+)(private.*;\s?//\s?)(\S+)
# 替换正则
$1@ApiModelProperty("$3")$1$2$3
7. 导入接口到apifox
启动项目后,swagger接口一般为{IFM_CONTEXT}/v3/api-docs
。 打开apifox进入对应项目,选择【项目设置】=》【导入数据(自动同步)】=》【新建数据源】按照提示配置swagger即可。 后续接口更新直接在导入数据菜单手动同步即可。