場景

swagger官網：

https://swagger.io/

效果

會將所有的接口Controller可視化顯示

點擊其中的Controller顯示具體的接口方法，左邊是請求的方式，中間是接口的url，右邊是接口說明。

點擊具體的方法，顯示方法說明和參數說明

輸入相應的參數，點擊Execute，可以在線測試接口。

可以查看接口返回數據。

實現

添加swagger2依賴

打開項目的pom.xml

<!--swagger2--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.8.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.8.0</version></dependency>

新建Swagger2配置類

在項目啟動類的同級，新建Swagger2的配置類Swagger2

package com.ws.api;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;@Configuration @EnableSwagger2 public class Swagger2 {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.ws.api.sys.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("API接口").description("").version("1.0").build();}}

注：

1.通過@Configuration注解來讓Spring加載該類配置。

2.通過@EnableSwagger2注解啟用Swagger2。

3. .apis(RequestHandlerSelectors.basePackage("com.ws.api.sys.controller"))來指定掃描Controller的包。

為接口添加文檔說明

找到Controller下的具體的接口的方法。

為接口API添加說明和說明信息

@ApiOperation(value="生成單件質檢單", notes="上位機掃碼，生成單件質檢單")

為接口添加參數說明

@ApiImplicitParam(name = "trayCode", value = "托盤編碼", required = true, dataType= "String")

多個參數的寫法：

?@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long"),@ApiImplicitParam(name = "user", value = "用戶詳細實體user", required = true, dataType = "User")})

完整示例代碼：

@Description("掃碼生成單件質檢單")@RequestMapping(value="/generatingSingleJianQualityTestOrder",method =RequestMethod.POST)@ResponseBody@ApiOperation(value="生成單件質檢單", notes="上位機掃碼，生成單件質檢單")@ApiImplicitParam(name = "trayCode", value = "托盤編碼", required = true, dataType = "String")public? Json generatingSingleJianQualityTestOrder(String trayCode) {return this.wmsMasterCleanFinishService.generatingSingleJianQualityTestOrder(trayCode);}

訪問在線API

啟動SpringBoot項目，在瀏覽器中輸入：

http://localhost:8080/swagger-ui.html

注意將項目端口號8080改成自己項目的端口號。

?

總結

以上是生活随笔為你收集整理的SpringBoot+Swagger2实现可视化API文档流程的全部內容，希望文章能夠幫你解決所遇到的問題。

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