接口管理的強大工具麦轰。demo地址在文章最后
項目現(xiàn)在前后端分離,需要一個API的管理工具翁巍,在分析了如下幾個最終選擇了,swagger休雌。比較主流的方式灶壶。
API管理
十分鐘搭建以springboot為項目的API管理
demo為第二種方式担扑,也是官方推薦
第一步
添加maven包
第一種方式:
<!-- https://mvnrepository.com/artifact/com.mangofactory/swagger-springmvc -->
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
第二種方式
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
官方建議是swagger2
第二步驟
添加Configuration配置
package com.swagger.config;
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;
@Configuration
public class SwaggerConfig {
@Bean
public Docket swaggerSpringMvcPlugin(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("springboot利用swagger構建api文檔")
.description("簡單優(yōu)雅的restfun風格")
.version("1.0")
.build();
}
}
第三步
啟動springboot項目恰响,訪問:localhost:
http://localhost:9999/swagger-ui.html