旭旭提供
為什么需要swagger
因?yàn)榻涌谖臋n管理非常麻煩叠聋，用過swagger煤惩，只需要配置一點(diǎn)點(diǎn)畜晰，就可以通過網(wǎng)頁很好的管理喻犁。
導(dǎo)入jar
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- 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>
本項(xiàng)目配置
package cn.zx.xuxu.product.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//唯一要改的地方就是這里的路徑 其他不管
.apis(RequestHandlerSelectors.basePackage("cn.zx.xuxu.product.controller"))
//包：就是自己接口的包路徑
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("商品系統(tǒng)api")//名字
.description("商品系統(tǒng)接口文檔說明")//額外藐視
.contact(new Contact("wbtest", "", "wenbing@zx.cn"))
.version("1.0")// 版本
.build();
}
}
本項(xiàng)目地址：http://127.0.0.1:8001/swagger-ui.html
旭旭提供
網(wǎng)關(guān)配置
前端開發(fā)每次都要記錄每個(gè)服務(wù)ip不好汽纤，期望只記憶網(wǎng)關(guān)ip就ok上岗，需要做配置
- 網(wǎng)關(guān)中配置
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- 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>
- 建個(gè)新類。在網(wǎng)關(guān)中
package cn.zx.xuxu.config;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
import java.util.ArrayList;
import java.util.List;
@Component
@Primary
public class DocumentationConfig implements SwaggerResourcesProvider {
@Override
public List<SwaggerResource> get() {
List resources = new ArrayList<>();
//aigou網(wǎng)關(guān)前綴,employee網(wǎng)關(guān)路徑 蕴坪；swagger的路徑 肴掷，以后增加了接口就在這配置就ok
resources.add(swaggerResource("用戶系統(tǒng)", "/xuxu/user/v2/api-docs", "2.0"));
resources.add(swaggerResource("商品系統(tǒng)", "/xuxu/product/v2/api-docs", "2.0"));
resources.add(swaggerResource("基礎(chǔ)系統(tǒng)", "/xuxu/common/v2/api-docs", "2.0"));
return resources;
}
private SwaggerResource swaggerResource(String name, String location, String version) {
SwaggerResource swaggerResource = new SwaggerResource();
swaggerResource.setName(name);
swaggerResource.setLocation(location);
swaggerResource.setSwaggerVersion(version);
return swaggerResource;
}
}
package cn.zx.xuxu.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("分布式購物系統(tǒng)")
.description("購物系統(tǒng)接口文檔說明")
.termsOfServiceUrl("http://localhost:8081")
.contact(new Contact("wbtest", "", "wenbing@itsoruce.cn"))
.version("1.0")
.build();
}
}
圖片.png
圖片.png
