Springcloud项目中通过网关使用swagger

Springcloud项目中通过网关使用swagger

网关中添加相关依赖

 <!-- swagger2 依赖 -->
        <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>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.8.1</version>
        </dependency>

编写swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Autowired
    private DiscoveryClientRouteLocator discoveryClientRouteLocator;

    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build()
                ;

    }

    private ApiInfo buildApiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("相关后台接口")
                .contact("wei")
                .version("1.0.0")
                .build();
    }

}

编写文档配置类

@Component
@Primary//自动装配时当出现多个Bean候选者时,被注解为@Primary的Bean将作为首选者,否则将抛出异常
public class DocumentationConfig implements SwaggerResourcesProvider {
    private final RouteLocator routeLocator;
    @Autowired
    private DiscoveryClient discoveryClient;

    public DocumentationConfig(RouteLocator routeLocator) {
        this.routeLocator = routeLocator;
    }

    @Value("${spring.application.name}")
    private String applicationName;

    @Override
    public List<SwaggerResource> get() {
        ArrayList<SwaggerResource> resources = new ArrayList<>();
        //排除自身,将其他服务添加进来
        discoveryClient.getServices().stream().filter(s ->
                !s.equals(applicationName))
                .forEach(name -> {
                    Optional<ServiceInstance> instanceOptional = discoveryClient.getInstances(name)
                            .stream().findFirst();
                    if (instanceOptional.isPresent() && instanceOptional.get().getMetadata().containsKey("context-path")) {
                        String contexPath = instanceOptional.get().getMetadata().get("context-path");
                        resources.add(swaggerResource(name, "/" + name + contexPath + "/v2/api-docs", "2.0"));
                    } else {
                        resources.add(swaggerResource(name, "/" + name + "/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;
    }
}

访问网关的swagger-ui.html

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值