SpringCloud-Zuul整合微服务所有API接口

Zull整合Swagger管理微服务所有API

1、各微服务项目引入依赖

<!-- swagger-spring-boot -->
<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.7.0.RELEASE</version>
</dependency>

2、application.xml配置扫包范围

swagger:
  base-package: api所在的包地址

3、项目启动加上注解@EnableSwagger2Doc

4、在对应的API类文件上加上@Api("当前API文档说明"),对应API方法上加@ApiOperation("接口说明");@ApiImplicitParam

5、网关中Swagger配置类

@Component
@Primary
public class DocumentationConfig implements SwaggerResourcesProvider {
    @Override
    public List<SwaggerResource> get() {
        List resources = new ArrayList<>();
        resources.add(swaggerResource("wegns", "/wegns-a/v2/api-docs", "2.0"));
        resources.add(swaggerResource("redis-proxy", "/redis-util/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;
    }
}

 

posted on 2019-11-22 15:35  JAVA-ROAD  阅读(1213)  评论(0)    收藏  举报

导航