Swagger 是一款RESTFUL接口的文檔在線自動生成+功能測試功能軟件。本文簡單介紹了在項目中集成swagger的方法和一些常見問題。如果想深入分析項目源碼，了解更多內容，見參考資料。
Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化RESTful 風格的Web 服務。總體目標是使客戶端和文件系統作為服務器以同樣的速度來更新。文件的方法，參數和模型緊密集成到服務器端的代碼，允許API來始終保持同步。 Swagger 讓部署管理和使用功能強大的API從未如此簡單。
對於搬磚的同學來說，寫接口容易，寫接口文檔很煩，接口變動，維護接口文檔就更更更煩，所以經常能發現文檔與程序不匹配。
等過一段時間就連開發者也蒙圈了
Swagger2快速方便的解決了以上問題。一個能與Spring MVC程序配合組織出強大RESTful API文檔的新寵兒。
下面直接上代碼
pom.xml
<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zhongxin.wealth</groupId> <artifactId>wealthweb</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>wealthweb</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.9.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency> </dependencies></project>
創建配置類
package com.zhongxin.wealth.apiConfig;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;/** * Created by DingYS on 2017/12/8. */@Configuration@EnableSwagger2public class Swagger2 { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.zhongxin.wealth.web")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("廊坊委貸大數據統計結果輸出接口") .version("1.0") .build(); }}controller編寫
package com.zhongxin.wealth.web;import io.swagger.annotations.ApiOperation;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;import org.springframework.web.bind.annotation.RestController;/** * Created by DingYS on 2017/12/7. */@RestController@RequestMapping("/hello")public class HelloWordController { @ApiOperation(value="測試接口", notes="這只是一個測試controller調用的接口，沒有任何的業務邏輯") @RequestMapping(value = {"/test"},method = RequestMethod.GET) public String testHello(){ return "hello"; }}代碼完成，準備看效果
點擊Try it out！
是不是很詳細，很高大上。
注：集成過程中剛開始用的swagger2.2.2版本，會在首頁出現一個error的錯誤提醒
{“schemaValidationMessages”:[{“level”:”error”,”message”:”Can't read from file http://127.0.0.1:8888/v2/api-docs"}]}但是瀏覽器訪問：http://127.0.0.1:8888/v2/api-docs 又能獲取結果
{“swagger”:”2.0”,”info”:{“version”:”1.0”,”title”:”廊坊委貸大數據統計結果輸出接口”,”contact”:{},”license”:{}},”host”:”127.0.0.1:8888”,”basePath”:”/“,”tags”:[{“name”:”hello-word-controller”,”description”:”Hello Word Controller”}],”paths”:{“/hello/test”:{“get”:{“tags”:[“hello-word-controller”],”summary”:”測試接口”,”description”:”這只是一個測試controller調用的接口，沒有任何的業務邏輯”,”operationId”:”testHelloUsingGET”,”consumes”:[“application/json”],”produces”:[“/“],”responses”:{“200”:{“description”:”OK”,”schema”:{“type”:”string”}},”401”:{“description”:”Unauthorized”},”403”:{“description”:”Forbidden”},”404”:{“description”:”Not Found”}}}}}}具體原因本人不明，換成2.7.0版本以後沒在出現。
總結
以上所述是小編給大家介紹的SpringBoot集成swagger的實例代碼，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對武林網網站的支持！