API Gateway：基於Swagger完成API Gateway的API管理

一、概述

API Gateway提供了完備的OpenAPI介面，使用者可以通過這些介面完成API Gateway的管理需要。使用者CICD整合API Gateway的核心，其實就是對API Gateway提供的管理介面進行封裝整合。

如下圖所示, 一個整合了API Gateway的通用CICD流程，主要有如下步驟：

• 步驟1：自動從您的API業務代碼中擷取Swagger定義。

• 步驟2：建立API分組。

• 步驟3：通過API Gateway的OpenAPI匯入API定義，並發布在不同的環境中。

• 步驟4：對API進行各項額外配置。

二、實現樣本

本章節對提供的範例程式碼進行講解說明，本文的範例程式碼僅提供了最基本的cicd情境，使用者可根據實際情況進行調整和擴充。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

@Configuration
@EnableSwagger2
public class SpringFoxConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

2.4 建立API分組

使用者可以通過以下方式建立分組

2.5 ImportSwagger介面的使用

使用者能否實現基於API Gateway的CICD流程，其核心關鍵是：

• 是否有介面可以擷取Swagger

• 標準Swagger如何匯入API Gateway

如2.2.2章節所介紹的內容，我們已經可以擷取描述後端服務所有介面和模型的Swagger。如何將標註的Swagger匯入到API Gateway是我們本章節的重點。

x-aliyun-apigateway-backend:
  type: HTTP
  address: 'http://www.aliyun.com'
  path: '/builtin/echo'
  method: get
  timeout: 10000

Maven依賴

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>alibabacloud-cloudapi20160714</artifactId>
  <version>3.0.38</version>
</dependency>

擷取使用者原生swagger

上文已經提及，使用者在完成SpringFox架構引入和配置後，在服務啟動時，就會自動產生/v2/api-docs介面用於擷取描述後端服務的Swagger。

    private String getSwaggerData(){
        HttpURLConnection connection = null;
        ...
        ...
        String result = null;
        try {
            URL url = new URL(swaggerApiDocUrl);
            connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("GET");
            connection.connect();
                                                ...
            ...
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
                                                ...
            ...
            connection.disconnect();
        }
        return result;
    }

配置基於API Gateway的Swagger擴充

正確的配置Swagger擴充是使用者通過匯入Swagger建立滿足其需求的API的核心環節. 這些基於API Gateway的Swagger擴充可以通過ImportSwagger介面中的globalCondition參數傳入. globalCondition的格式為Json String。

• key: 基於Swagger的API Gateway擴充的名稱, 如：x-apigateway-backend-in

• value: 對應Swagger擴充的值。

範例程式碼中，通過配置API的通用後端地址，實現匯入API Gateway的API可以訪問到其真正的後端服務。

為了範例程式碼的整潔，我們根據2.5.1中HTTP類型的後端服務說明，建立SwaggerBackendInfoBase類，用於配置後端服務資訊。

public class SwaggerBackendInfoBase {
    private String type;
    private String address;
    public String getType() {
        return type;
    }
    public void setType(String type) {
        this.type = type;
    }
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
}

我們根據使用者的後端服務資訊，完成globalCondition參數的賦值。

            // 配置API Gateway所需的服務後端資訊
            SwaggerBackendInfoBase info = new SwaggerBackendInfoBase();
            info.setType("HTTP");
            info.setAddress("http://www.aliyun.com");
            // 將API的後端服務後端資訊
            Map<String, String> globalCondition  = new HashMap<>();
            globalCondition.put("x-aliyun-apigateway-backend", JSON.toJSONString(info));

ImportSwagger

上文中，我們已經完成了Group的建立，原生Swagger的擷取以及GlobalCondition參數的建立。我們調用API Gatewayopenapi提供的ImportSwagger介面完成API的匯入，並可以API Gateway控制台查看匯入結果。

2.6 部署API

使用者可以在API管理頁面選擇對應的分組，通過選擇需要發布的API進行發布。使用者通過發布使匯入的API生效。

三、總結

自此, 如何將使用者後端服務的API介面快速的同步到API Gateway已經完成。API Gateway致力於讓使用者專註於後端服務的開發, 將認證、流控等通用切面功能交給API Gateway處理，結合ImportSwagger介面的使用，完成後端服務與API Gateway的聯動，大大減少了API Gateway的配置過程。同時，讓API Gateway的配置和管理整合到使用者的CICD流程中成為可能。