Swagger学习

Swagger的产生背景：

主要原因是因为前后端项目的分离开发

• 前端任务 -> 前端控制层、视图层
• 后端 任务-> 后端控制层、服务层、数据访问层
• 前后端通过API进行交互
• 前后端相对独立且松耦合

由此产生的问题：
前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发
解决方案：
首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险，因此有了Swagger的出现

---

Swagger简介

• 号称世界上最流行的API框架

• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

• 直接运行，在线测试API

• 支持多种语言 （如：Java，PHP等）

• 官网：https://swagger.io/

---

Swagger在SpringBoot项目上的集成

主要要导入两个jar包：

• Springfox-swagger2
• swagger-springmvc

ps: 需要使用jdk 1.8 ，否则swagger2无法运行
具体步骤：
1、新建一个SpringBoot-web项目
2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

3、编写HelloController，测试确保运行成功！
4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
     
}

5、访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

---

配置Swagger信息

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   
   return new Docket(DocumentationType.SWAGGER_2);
}

2、可以通过apiInfo()属性配置文档信息

//配置文档信息
private ApiInfo apiInfo() {
   
   Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
   return new ApiInfo(
           "Swagger学习", // 标题
           "学习演示如何配置Swagger", // 描述
           "v1.0", // 版本
           "http://terms.service.url/组织链接", // 组织链接
           contact, // 联系人信息
           "Apach 2.0 许可", // 许可
           "许可链接", // 许可连接
           new ArrayList<>()// 扩展
  );
}

3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
   
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

如下图：
4、重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；
则会发现Swagger的页面配置信息改变

---

配置Swagger扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

@Bean