- 后台服务Swagger配置
package com.synda.conmmon.config;
import lombok.Data;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.stereotype.Component;
import springfox.documentation.builders.*;
import springfox.documentation.schema.ScalarType;
import springfox.documentation.service.*;
import springfox.documentation.spi.documentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
@Component
@Data
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
@Bean
public Docket webApiDoc(){
//enable(true) 定义是否开启swagger,false是关闭,可以通过变量去控制
return new Docket(documentationType.OAS_30)
.pathMapping("/")
.enable(true)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.synda.seckill.user"))
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.ant("/api
private ApiInfo apiInfo(){
return new ApiInfoBuilder().title("Spring-cloud-alibaba学习接口文档").description("微服务接口文档").contact(new Contact("xxx","https://xdclass.net","1162918839@qq.com")).version("V1.0").build();
}
private List requestParameters(){
List parameters = new ArrayList<>();
parameters.add(new RequestParameterBuilder().name("token").description("登录令牌").in(ParameterType.HEADER).query(q->q.model(m->m.scalarModel(ScalarType.STRING))).required(false).build());
return parameters;
}
private List responses(){
List responses = new ArrayList<>();
responses.add(new ResponseBuilder()
.code("4xx").description("错误返回").build());
return responses;
}
}
- 网关配置
package com.synda.seckill.gateway.config;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.gateway.route.RouteLocator;
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.HashSet;
import java.util.List;
import java.util.Set;
@Primary
@Component
public class MySwaggerResourceProvider implements SwaggerResourcesProvider {
private static final String SWAGGER2URL = "/v2/api-docs";
private final RouteLocator routeLocator;
@Value("${spring.application.name}")
private String self;
@Autowired
public MySwaggerResourceProvider(RouteLocator routeLocator) {
this.routeLocator = routeLocator;
}
@Override
public List get() {
List resources = new ArrayList<>();
List routeHosts = new ArrayList<>();
// 获取所有可用的host:serviceId
routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
.filter(route -> !self.equals(route.getUri().getHost()))
.subscribe(route -> routeHosts.add(route.getUri().getHost()));
// 记录已经添加过的server,存在同一个应用注册了多个服务在eureka上
Set dealed = new HashSet<>();
routeHosts.forEach(instance -> {
// 拼接url
String url = "/" + instance + SWAGGER2URL;
if (!dealed.contains(url)) {
dealed.add(url);
SwaggerResource swaggerResource = new SwaggerResource();
swaggerResource.setUrl(url);
swaggerResource.setName(instance);
resources.add(swaggerResource);
}
});
return resources;
}
}
package com.synda.seckill.gateway.controller;
import com.synda.seckill.gateway.config.MySwaggerResourceProvider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.swagger.web.*;
import java.util.List;
@RestController
@RequestMapping("/swagger-resources")
public class SwaggerResourceController {
private MySwaggerResourceProvider mySwaggerResourceProvider;
@Autowired
public SwaggerResourceController(MySwaggerResourceProvider mySwaggerResourceProvider) {
this.mySwaggerResourceProvider = mySwaggerResourceProvider;
}
@RequestMapping(value = "/configuration/security")
public ResponseEntity securityConfiguration() {
return new ResponseEntity<>(SecurityConfigurationBuilder.builder().build(), HttpStatus.OK);
}
@RequestMapping(value = "/configuration/ui")
public ResponseEntity uiConfiguration() {
return new ResponseEntity<>(UiConfigurationBuilder.builder().build(), HttpStatus.OK);
}
@RequestMapping
public ResponseEntity> swaggerResources() {
return new ResponseEntity<>(mySwaggerResourceProvider.get(), HttpStatus.OK);
}
}