廢話不說 直接分析
-
什麼是SwaggerUI?參考 https://www.cnblogs.com/JoiT/p/6378086.html
Swagger能成爲最受歡迎的REST APIs文檔生成工具之一,有以下幾個原因:Swagger 可以生成一個具有互動性的API控制檯,開發者可以用來快速學習和嘗試API。
Swagger 可以生成客戶端SDK代碼用於各種不同的平臺上的實現。
Swagger 文件可以在許多不同的平臺上從代碼註釋中自動生成。
Swagger 有一個強大的社區,裏面有許多強悍的貢獻者
2、搭建一個SpringBoot 案例 集成SwaggerUI 導入對應Maven pom.xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.0</version>
</dependency>
<dependency>
<groupId>io.springfox </groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.0</version>
</dependency>
3、編寫Swagger 加載配置類
package com.api.swagger;
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;
/**
*
* @ClassName: Swagger2Config
* @Description:TODO(swagger 配置)
* @author: drj
* @date: 2019年1月19日 下午8:10:52
*
* @Copyright: 2019
*
*/
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.api")).paths(PathSelectors.any())
.build();
}//PathSelectors.regex("/v1/")
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("dairuijie Restful API").description("代瑞傑 API")
.version("1.0").build();
}
}
4、啓動項目,瀏覽器輸入 http://127.0.0.1:8888/swagger-ui.html# 自己的項目ip+port 如圖:
5、git 項目地址 https://github.com/dairuijie/api.git 有具體註解 使用demo