一、步骤概览
二、步骤说明
1.引入依赖
- springfox-boot-starter：Swagger 3.0 依赖包，用于为 Spring 应用程序生成 API 文档。
- knife4j-spring-boot-starte：Swagger 增强工具，它可以帮助开发者更好地管理和展示 API 文档。
2.定义配置信息
在 application.yml 配置文件中定义 swagger 相关的配置信息，主要包括系统标题、分组名称、是否开启、描述信息、版本信息、扫描路径、组织链接、联系人名称、联系人url、联系人email等。
- application.yml
其中
spring.mvc.pathmatch.matching-strategy=ant_path_matcher，是防止REST API 的请求路径中包含正则表达式或者 . 等特殊字符时，可能会导致 Swagger3 无法正确地解析路径信息。
- SwaggerProperty：配置信息实体类
3.实现配置类
根据配置文件，配置 Swagger3 的相关信息和生成 API 文档。SwaggerConfig.java代码概览如下图所示
- SwaggerConfig
- SwaggerConfig#createApiDoc：创建 API 文档
4.配置发布接口
在控制层接口上，配置相关注解，完成接口文档的发布。下面就以用户管理为示例展示.
- UserController: 用户管理，使用 @Api 注解对接口进行标记，属性tags用于指定该接口所属的标签或分类
- UserController#addUser：新增用户，@ApiOperation 用于描述单个接口的操作信息，属性value 表示接口的简要描述，属性notes 表示接口的详细说明，属性 produces 表示接口的响应结果类型。
UserController#queryUser：查询用户
5.访问接口文档
经过上面的配置步骤，启动项目后，访问地址
http://127.0.0.1:8080/doc.html 查看接口文档 ，如果项目中配置了权限管理，需要将文档访问地址进行相关权限的设置。