SpringCloud系列之三---Zuul網關整合Swaagger2管理API

前言

本篇文章主要介紹的是Zuul網關整合Swaagger2管理API。

實現過程需要先創建eureka服務端，再創建多個微服務項目，每個微服務項目整合swagger2，形成接口文檔，並且每個微服務需要註冊到eureka註冊中心。再創建zuul網關對所有的swagger進行管理,zuul網關也需要作爲eureka客戶端註冊到註冊中心。

GitHub源碼鏈接位於文章底部。

1.eureka服務端

首先創建eureka註冊中心，因爲這只是一個註冊中心，所以只需要引入eureka服務端jar即可。

1.1 pom依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    </dependency>
</dependencies>

1.2 配置文件

生產環境中需要開啓自我保護機制，刪除eureka.server

server:
  port: 8100

spring:
  application:
    name: eureka-server

#eureka基本配置信息
eureka:
  client:
    service-url:
      #Eureka 客戶端與 Eureka 服務端進行交互的地址
      defaultZone: http://127.0.0.1:${server.port}/eureka
    #是否將自己註冊到Eureka服務中,本身就是註冊中心所以無需註冊
    register-with-eureka: false
    #是否從Eureka中檢索註冊信息,本身就是註冊中心所以無需檢索
    fetch-registry: false
  server:
    # 測試時關閉自我保護機制，保證不可用服務及時踢出
    enable-self-preservation: false
    ##剔除失效服務間隔
    eviction-interval-timer-in-ms: 2000

1.3 啓動類

在方法上添加eureka服務端註解EnableEurekaServer。

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApp {
    public static void main(String[] args) {
        SpringApplication.run(EurekaServerApp.class, args);
    }
}

啓動以後訪問 127.0.0.1:8100 即可打開eureka註冊中心可視化界面。

2.創建用戶服務和郵件服務兩個項目

創建用戶服務和郵件服務兩個項目，這兩個服務需要作爲eureka客戶端，註冊到eureka註冊中心，兩個服務都需要整合swagger2，用戶服務需要使用Feign調用郵件服務。

2.1郵件服務引入依賴

郵件服務作爲eureka客戶端，以及需要整合swagger2，因此只需要引入兩個依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.7.0.RELEASE</version>
    </dependency>
</dependencies>

2.2郵件服務配置文件

配置文件包括配置端口、應用名、eureka客戶端信息、swagger配置信息，需要注意swagger配置了controller層所在的包，它會檢測包中swagger相關注解。

server:
  port: 8200

spring:
  application:
    name: app-email

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8100/eureka
  server:
    # 測試時關閉自我保護機制，保證不可用服務及時踢出
    enable-self-preservation: false
    ##剔除失效服務間隔
    eviction-interval-timer-in-ms: 2000

####swagger相關配置
swagger:
  base-package: com.lxg.controller
  title: SpringCloud2.x構建微服務項目-郵件服務接口
  description: 郵件有關的服務
  version: 1.1
  terms-of-service-url: www.lxgblog.com
  contact:
    name: 李先國
    email: [email protected]

2.3 郵件服務controller層

在郵件服務中寫一個獲取郵件信息的Get接口，Api(tags = "郵件微服務")是swagger的註解，它爲controller命名，swagger其他註解見另一篇文章https://www.lxgblog.com/article/1576055897

@RestController
@Api(tags = "郵件微服務")
public class EmailController {
    @GetMapping("/email")
    public String email() {
        return "[email protected]";
    }
}

2.4 郵件服務啓動類

EnableSwagger2Doc註解開啓swagger，EnableEurekaClient啓動eureka客戶端

@SpringBootApplication
@EnableSwagger2Doc
@EnableEurekaClient
public class EmailApp {
    public static void main(String[] args) {
        SpringApplication.run(EmailApp.class,args);
    }
}

2.5 用戶服務引入依賴

用戶服務作爲eureka客戶端，需要整合swagger2，並且它需要通過Feign遠程調用郵件服務，所以是三個依賴。

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.7.0.RELEASE</version>
        </dependency>
    </dependencies>

2.6 用戶服務配置文件

配置文件包括配置端口、應用名、eureka客戶端信息、swagger配置信息，需要注意swagger配置了controller層所在的包，它會檢測包中swagger相關注解。

server:
  port: 8300

spring:
  application:
    name: app-user

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8100/eureka
  server:
    # 測試時關閉自我保護機制，保證不可用服務及時踢出
    enable-self-preservation: false
    ##剔除失效服務間隔
    eviction-interval-timer-in-ms: 2000

####swagger相關配置
swagger:
  base-package: com.lxg.controller
  title: SpringCloud2.x構建微服務項目-用戶服務接口
  description: 用戶有關的服務
  version: 1.1
  terms-of-service-url: www.lxgblog.com
  contact:
    name: 李先國
    email: [email protected]

2.7 用戶服務的Feign

用戶服務需要調用郵件服務，所以需要創建一個EmailFeign的interface，使用FeignClient註解，值爲郵件服務的應用名，這在郵件服務的配置文件中有，然後將郵件服務中需要被調用的接口拷貝到這裏（包括方法上的註解）

@FeignClient("app-email")
public interface EmailFeign {
    @GetMapping("/email")
    public String email();
}

2.8 用戶服務的controller層

在用戶服務中寫一個調用郵件服務的Get接口，Api(tags = "用戶微服務")是swagger的註解，它爲controller命名，swagger其他註解見另一篇文章https://www.lxgblog.com/article/1576055897 ，同時將郵件Feign注入進來，通過它調用的方法其實是調用的遠程服務。

@RestController
@Api(tags = "用戶微服務")
public class UserController {
    @Autowired
    private EmailFeign emailFeign;

    @GetMapping("/user")
    public String user() {
        return "用戶獲取郵箱："+emailFeign.email();
    }
}

2.9 用戶服務啓動類

EnableSwagger2Doc註解開啓swagger，EnableEurekaClient啓動eureka客戶端，EnableFeignClients啓動Feign客戶端。

@SpringBootApplication
@EnableEurekaClient
@EnableSwagger2Doc
@EnableFeignClients
public class UserApp {
    public static void main(String[] args) {
        SpringApplication.run(UserApp.class, args);
    }
}

啓動這兩個服務後，直接調用郵件服務中的接口：

通過調用用戶服務的接口調用郵件服務：

分別訪問127.0.0.1:8200/swagger-ui.html,127.0.0.1:8300/swagger-ui.html，也可以使用swagger測試上述接口：

3.創建Zuul網關整合兩個服務的swagger

3.1 Zuul網關引入依賴

它需要作爲eureka服務端注入到eureka註冊中心，作爲zuul網關，整合swagger，因此需要引入如下三個依賴：

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.7.0.RELEASE</version>
        </dependency>
    </dependencies>

3.2 Zuul的配置文件

配置文件包括了端口號、服務名稱、eureka客戶端配置，網關反向代理配置。zuul.routes.api-user中的api.user可以任意命名，只要不重複即可，這裏只作爲區分。訪問網關項目+path的值+相關服務接口的URI，就相當於直接訪問對應服務的接口。

###服務啓動端口號
server:
  port: 80
###服務名稱(服務註冊到eureka名稱)
spring:
  application:
    name: app-zuul
###服務註冊到eureka地址
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8100/eureka


### 配置網關反向代理
zuul:
  routes:
    api-user:
      path: /api-user/**
      serviceId: app-user
    api-email:
      path: /api-email/**
      serviceId: app-email

3.3 Zuul的啓動類

在啓動類上加入EnableEurekaClient註解開啓eureka客戶端，EnableZuulProxy註解開啓網關，EnableSwagger2Doc註解開啓swagger。
在啓動類中整合了不同服務中的swagger

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
@EnableSwagger2Doc
public class AppZuul {
    public static void main(String[] args) {
        SpringApplication.run(AppZuul.class, args);
    }

    // 添加文檔來源
    @Component
    @Primary
    class DocumentationConfig implements SwaggerResourcesProvider {
        @Override
        public List<SwaggerResource> get() {
            List resources = new ArrayList<>();
            resources.add(swaggerResource("app-user", "/app-user/v2/api-docs", "2.0"));
            resources.add(swaggerResource("app-email", "/app-email/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;
        }

    }
}

啓動網關服務後，訪問127.0.0.1/swagger-ui.html

因爲配置的是80端口，因此瀏覽器訪問會省略80端口

通過網關訪問郵件服務的接口，127.0.0.1/api-email/email和上面的127.0.0.1:8200/email是一樣的

通過網關訪問用戶服務的接口去調用郵件服務的接口，127.0.0.1/api-user/email和上面的127.0.0.1:8300/user是一樣的

這是由zuul配置文件中反向代理配置的。

本文GitHub源碼：https://github.com/lixianguo5097/springcloud/tree/master/springcloud-springcloud-zuul-swagger2

CSDN：https://blog.csdn.net/qq_27682773
簡書：https://www.jianshu.com/u/e99381e6886e
博客園：https://www.cnblogs.com/lixianguo
個人博客：https://www.lxgblog.com

SpringCloud系列之三---Zuul網關整合Swaagger2管理API

前言

1.eureka服務端

1.1 pom依賴

1.2 配置文件

1.3 啓動類

2.創建用戶服務和郵件服務兩個項目

2.1郵件服務引入依賴

2.2郵件服務配置文件

2.3 郵件服務controller層

2.4 郵件服務啓動類

2.5 用戶服務引入依賴

2.6 用戶服務配置文件

2.7 用戶服務的Feign

2.8 用戶服務的controller層

2.9 用戶服務啓動類

3.創建Zuul網關整合兩個服務的swagger

3.1 Zuul網關引入依賴

3.2 Zuul的配置文件

3.3 Zuul的啓動類

阿里雲免費申請SSL證書實現網站HTTPS化

SpringCloud系列之三---Zuul網關整合Swaagger2管理API

Springboot整合SpringDataJPA基於Restful風格實現增刪改查功能

springboot整合swagger2+跨域問題

乾貨滿滿的開發資源

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結