一、Swagger簡介

1.1前后端分離

前端—> 前端控制層、視圖層
后端—> 后端控制層、服務層、數據訪問層
前后端通過API進行交互
前后端相對獨立且松耦合

1.2產生的問題

前后端集成，前端或者后端無法做到“及時協商，盡早解決”，最終導致問題集中爆發

1.3解決方案

首先定義schema【計劃的提綱】，并實時跟蹤最新的API，降低集成風險；

因此，Swagger應運而生

1.4Swagger

（一）號稱世界上最流行的API框架
（二）Restful Api 文檔在線自動生成器 => Api文檔與API定義同步更新
（三）直接運行，在線測試API
（四）支持多種語言【如java、PHP等】
（五）官網

二、SpringBoot集成Swagger

2.1 新建一個SpringBoot=web項目

2.2 導入相關的依賴

<!-- 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><!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency>

2.3創建config>SwaggerConfig

//定義配置類 @Configuration @EnableSwagger2//開啟swagger2 public class SwaggerConfig {}

2.4配置Swagger

//配置Swagger的Docket的bean實例@Beanpublic Docket docket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());}//配置swagger信息public ApiInfo apiInfo(){Contact contact = new Contact("琴江","http://www.zhaoliangliang.work/","1003989507@qq.com");return new ApiInfo("亮哥的SwaggerAPI文檔","即使再小的帆也能遠航","v2.2","http://www.zhaoliangliang.work/",contact,"Apache 2.0","http://www.zhaoliangliang.work/",new ArrayList());}

2.5測試瞅瞅

三、Swagger配置掃描接口

//配置Swagger的Docket的bean實例@Beanpublic Docket docket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//RequestHandlerSelectors,配置要掃描接口的方式//basePackage:指定要掃描的包//any():掃描全部//none():不掃描//withClassAnnotation:掃描類上的注解，參數是一個注解的反射對象//withMethodAnotation:掃描方法上的注解.apis(RequestHandlerSelectors.basePackage("com.teaiyang.swagger.controller"))//path() 過濾什么路徑.paths(PathSelectors.ant("/swagger/**")).build();}

配置是否啟動Swagger

//配置Swagger的Docket的bean實例@Beanpublic Docket docket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("亮亮組").enable(false)//enable是否啟動swagger，如果false 則swagger不能再瀏覽器中訪問.select().apis(RequestHandlerSelectors.basePackage("com.teaiyang.swagger.controller"))//.paths(PathSelectors.ant("/swagger/**")).build();}

四、問題：我只希望我的Swagger在生成環境中使用，在發布環境不使用？

（一）在application.yml中

springconfig:enable: true

（二）swagger配置類中

@Value("${springconfig.enable}")private boolean enable;

五、用戶實體

@ApiModel( ) //主要用來標注返回的實體類
@ApiModelProperty( ) //主要用來標注實體類中的屬性

@ApiModel("用戶的實體類") public class User implements Serializable{@ApiModelProperty("用戶的id")private Integer id;@ApiModelProperty("用戶名")private String username;@ApiModelProperty("用戶的密碼")private String password;@ApiModelProperty("用戶的年齡")private Integer age;get/set/tostring

@ApiModelProperty用來標注API接口

@RestController public class UserController {@ApiModelProperty("得到一個user")@GetMapping("/getUser")public User getUser(){return new User(1,"趙亮亮","papap",12);} }

測試：

總結

以上是生活随笔為你收集整理的Swagger体验版的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。