Swagger-API文档接口引擎
Swagger是什么
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
在项目开发中,根据业务代码自动生成API文档,给前端提供在线测试,自动显示JSON格式,方便了后端与前端的沟通与调试成本。
Swagger有一个缺点就是侵入性模式,必须配置在具体的代码里。
Swagger使用(SpringBoot+Swagger集成)
新建Maven项目
第一种方式:使用第三方依赖
1.在pom.xml文件中添加第三方swagger依赖
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.7.0.RELEASE</version>
</dependency>
2、在Spring Boot项目的启动类上添加@EnableSwagger2,启动Swagger
3、https://github.com/SpringForAll/spring-boot-starter-swagger,GitHub上这个swagger依赖实现的项目,里面有详细的讲解。
第二种方式:使用官方依赖
1.在pom.xml文件中添加swagger相关依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-core-asl</artifactId>
<version>1.9.13</version>
</dependency>
第一个是API获取的包
第二是官方给出的一个ui界面,这个界面可以自定义,默认是官方的
第三个是测试数据以JSON格式返回的依赖包