首页　>　文章列表　>　使用Kong管理API网关：在Beego中的集成与使用

使用Kong管理API网关：在Beego中的集成与使用

API网关 Beego Kong
444 2024-01-21

随着微服务架构的流行，API网关越来越受到关注。作为微服务架构中的重要组成部分之一，API网关是一个负责分发请求、路由请求以及过滤请求的应用程序。在许多企业中，Kong已成为最流行的API网关之一，因为其灵活、可扩展且易于使用。

Beego是一个快速开发Go应用程序的框架，可以提供RESTful API开发的支持。在这篇文章中，我们将探讨如何在Beego中使用Kong进行API网关管理。

安装Kong

首先，我们需要安装Kong。Kong可以在不同的平台上运行，包括Windows、Linux、Docker等。这里以在Linux上安装Kong为例。

使用yum安装Kong：

$ echo '[bintray--kong-kong-rpm]
name=bintray--kong-kong-rpm
baseurl=https://kong.bintray.com/kong-community-edition-rpm/centos/$releasever/$basearch/
gpgcheck=0
repo_gpgcheck=0
enabled=1' | sudo tee /etc/yum.repos.d/bintray-kong-kong-rpm.repo
$ sudo yum install -y kong

安装完成后，运行kong启动Kong服务。

创建API

在Beego中实现API，并将其注册到Kong中，使其成为可供外部访问的API。

在Beego中实现API比较简单，这里不做过多介绍。需要注意的是，需要在Beego中使用Kong的Admin API，因此需要安装Kong的官方Go客户端：kong-go-sdk。

$ go get github.com/Kong/go-kong/kong

在创建API之前，我们需要有一个Kong Admin API的客户端对象，如下所示：

import "github.com/Kong/go-kong/kong"

const KongAdminURL = "http://localhost:8001"

func NewKongClient() (*kong.Client, error) {
    return kong.NewClient(kong.String(KongAdminURL))
}

然后，我们可以通过代码实现API的注册。下面是一个简单的例子：

func RegisterAPI(name, upstreamURL, requestHost, stripPath string) error {
    kongClient, err := NewKongClient()
    if err != nil {
        return fmt.Errorf("create kong client error: %v", err)
    }

    targetURL, err := url.Parse(upstreamURL)
    if err != nil {
        return fmt.Errorf("parse target url error: %v", err)
    }

    api := &kong.API{
        Name:        kong.String(name),
        Uris:        kong.StringSlice("/" + name),
        UpstreamURL: kong.String(targetURL.String()),
        RequestHost: kong.String(requestHost),
        StripUri:    kong.Bool(true),
        StripPath:   kong.Bool(stripPath),
    }

    _, err = kongClient.APIs().Create(kongContext.Background(), api)
    if err != nil {
        return fmt.Errorf("register api to kong error: %v", err)
    }

    return nil
}

在上面的代码中，我们首先创建了一个Kong Admin API的客户端对象，然后使用 kong.API 创建一个 API 对象，如API名称、API对应的 Upstream URL、请求的域名、是否启用URI去除、是否启用URI截断等选项。最后，我们使用Kong Admin API 的 client 创建API。

接下来，我们需要配置Kong，增加插件和路由来指定请求和响应的处理。

配置Kong

Kong支持许多插件，使我们可以在请求和响应时进行更高级的处理。常用的插件包括rate-limiting、key-auth和oauth2等。在这里，我们将使用rate-limiting插件来限制API的访问速度。

func AddPlugin(apiName string) error {
    kongClient, err := NewKongClient()
    if err != nil {
        return fmt.Errorf("create kong client error: %v", err)
    }

    api, err := kongClient.APIs().Get(kongContext.Background(), &apiName)
    if err != nil {
        return fmt.Errorf("get api error: %v", err)
    }

    plugin := &kong.RateLimiting{
        Name:       kong.String("rate-limiting"),
        ConsumerID: nil,
        Limit:      kong.Int(10),
        Policy:     kong.String("local"),
    }

    _, err = kongClient.Plugins().Create(kongContext.Background(), &kong.Plugin{
        APIID: api.ID,
        Name:  plugin.Name,
        Config: kong.Configuration{
            kong.String("consumer_id"): plugin.ConsumerID,
            kong.String("limit"):       plugin.Limit,
            kong.String("policy"):      plugin.Policy,
        },
    })

    if err != nil {
        return fmt.Errorf("add rate-limiting plugin error: %v", err)
    }

    return nil
}

func AddRoute(apiName string) error {
    kongClient, err := NewKongClient()
    if err != nil {
        return fmt.Errorf("create kong client error: %v", err)
    }

    route := &kong.Route{
        Name:   kong.String(apiName),
        Paths:  kong.StringSlice(fmt.Sprintf("/%s", apiName)),
        StripPath: kong.Bool(true),
        PreserveHost: kong.Bool(false),
        RegexPriority: kong.Int(0),
        Service: &kong.Service{
            ID: kong.String(apiName),
        },
    }

    _, err = kongClient.Routes().Create(kongContext.Background(), route)
    if err != nil {
        return fmt.Errorf("add route error: %v", err)
    }

    return nil
}

在上面的代码中，我们使用链式调用实现了Kong的插件和路由。

为了演示方便，我们只添加了一个限流插件。运行CreateRateLimiting函数，我们会在Kong网关中创建一个名为“rate-limiting”的插件，并将其应用到名为“api-name”的API上。代码中，10代表了并发请求数的限制。

运行方法时需要传入API的名称，我们需要先使用api名称在网关中创建API。调用 RegisterAPI 函数，向Kong网关中注册我们在 Beego 应用程序中实现的API。

在运行 AddPlugin 函数和 AddRoute 函数后，我们的 API 已经注册到 Kong 网关中。

这里我们采用的是在 Beego 应用程序中直接向 Kong API 网关注册 API 的方法，其实 Kong 也支持使用配置文件或其他方式通过 Kong Manager 或者 Kong Dashboard 进行 API 的注册。不过这些方式需要我们手动地在 Kong API 网关后台操作，操作繁琐、耗时。

最后，我们只需要通过Kong的API网关访问我们在Beego中实现的API。我们可以使用Postman或者其他REST client来进行测试。