1. 在pom文件内添加Maven依赖,这里选择3.0.0版本
<!-- swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2. 启动类上加上注解@EnableOpenApi
@SpringBootApplication
@EnableOpenApi
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class,args);
}
}
3. 浏览器输入链接:localhost:8080/swagger-ui/index.html(端口号根据自己设置的写)
http://localhost:8080/swagger-ui/index.html
4. 显示如下界面即配置成功:
5. 使用Swagger集成文档具有以下几个优势:
- 功能丰富:支持多种注解,自动生成接口文档界面,支持在界面测试API接口功能。
- 及时更新:开发过程中花一点写注释的时间,就可以及时地更新API文档,省心省力。
- 整合简单:通过添加pom依赖和简单配置,内嵌于应用中就可同时发布API接口文档界面,不需要部署独立服务。
6. 官方网站:https://swagger.io/
官方文档:https://swagger.io/docs/
7. 参考书籍:
[1]徐立建.SpringBoot+SpringCloud+Vue+Element项目实战:手把手教你开发权限管理系统[M].北京:清华大学出版社.