springcloud-zuul-swagger

1、引用依赖

      <!-- zuul不兼容改成2.0.5版本https://blog.csdn.net/qq_25627105/article/details/84030682 -->
      <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
        <relativePath />
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <maven-jar-plugin.version>2.6</maven-jar-plugin.version>
        <spring-cloud.version>Finchley.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <!-- SpringBoot Web容器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 版本兼容异常包 -->
         <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>16.0.1</version>
        </dependency>
        <!-- springcloud -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- zuul -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <!-- swagger-spring-boot -->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.7.0.RELEASE</version>
        </dependency>
       <!-- apollo jar包 -->
        <dependency>
            <groupId>com.ctrip.framework.apollo</groupId>
            <artifactId>apollo-client</artifactId>
            <version>1.1.0</version>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-api</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

</dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2、bootstrap.properties配置文件

app.id=xgdfin-api-swagger
apollo.meta=http://127.0.0.1:6001

#Mac/Linux: /opt/data/{appId}/config-cache
#Windows: C:\opt\data\{appId}\config-cache
#apollo.cacheDir=/opt/data/some-cache-dir
#apollo.cluster=SomeCluster
apollo.bootstrap.enabled = true
apollo.bootstrap.namespaces=application
apollo.autoUpdateInjectedSpringProperties=true

 

Apollo配置文件中心内容:

server.port = 6002
#服务名称
spring.application.name = sirius-api-swagger
#注册中心
eureka.client.serviceUrl.defaultZone = http://admin:123456@10.18.6.22:6001/eureka/
#表示是否将自己注册到Eureka Server
eureka.client.registerWithEureka = false
#表示是否从Eureka Server获取注册信息
eureka.client.fetchRegistry = true
#LOG
logging.file = ./logs/log.log

apiServiceList = api-business

3、启动类

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
@EnableSwagger2Doc
@RestController
@EnableApolloConfig()
public class ApiSwaggerApplicationStart extends SpringBootServletInitializer {

    /** 日志记录 */
    private static final Logger log = LoggerFactory
            .getLogger(ApiSwaggerApplicationStart.class);
    @Value("${apiServiceList}")
    private String apiServiceList;

    @Override
    protected SpringApplicationBuilder configure(
            SpringApplicationBuilder application) {
        return application.sources(ApiSwaggerApplicationStart.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(ApiSwaggerApplicationStart.class, args);
        log.info("(♥◠‿◠)ﾉﾞ xgdfin-api-swagger系统启动成功   ლ(´ڡ`ლ)ﾞ  \n");
    }

    @RequestMapping("/test")
    public String test() {
        return "test";
    }

    @Bean
    @RefreshScope
    @ConfigurationProperties("zuul")
    @Primary
    public ZuulProperties zuulProperties() {
        return new ZuulProperties();
    }

    @Component
    @Primary
    class DocumentationConfig implements SwaggerResourcesProvider {
        @Override
        public List<SwaggerResource> get() {
            List resources = new ArrayList<>();
            System.out.println(apiServiceList);
            String[] apiServiceLists = apiServiceList.split(",");
            if (apiServiceLists != null) {
                for (int i = 0; i < apiServiceLists.length; i++) {
                    resources.add(swaggerResource(apiServiceLists[i], "/"
                            + apiServiceLists[i] + "/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;
        }
    }

接口文档http://localhost:9503/swagger-ui.html