Kong Document(0.9.x) Note

1. Installation

略。

每个平台的安装方式不一样，我目前使用的是 Debian 8来安装的。

数据库：Postgres 9.4

参考

2. Quickstart

1. start kong

   kong start
   # 可以同 -c <path_to_config> 的选项指向配置文件。默认在/etc/kong下边
   

2. 验证是否启动成功

   1. :8000：API 请求的代理层端口
   2. :8001：RESTful Admin API for configuration

3. 其他

   kong stop
   kong reload
   

3. 添加 API

1. 使用 RESTful API 添加你的 API

   curl -i -X POST \
     --url http://localhost:8001/apis/ \
     --data 'name=mockbin' \
     --data 'upstream_url=http://mockbin.com/' \
     --data 'request_host=mockbin.com'
   

2. 验证你的 API 是否被添加

   出于安全考虑，建议启用 Request Size Limiting 插件，防止 DOS 攻击

   HTTP/1.1 201 Created
   Content-Type: application/json
   Connection: keep-alive
   
   {
     "request_host": "mockbin.com",
     "upstream_url": "http://mockbin.com/",
     "id": "2eec1cb2-7093-411a-c14e-42e67142d2c4",
     "created_at": 1428456369000,
     "name": "mockbin"
   }
   

3. 通过 Kong 转发你的请求

   以下代码验证 Kong 会正确的转发你的请求到你的 API：

   $ curl -i -X GET \
     --url http://localhost:8000/ \
     --header 'Host: mockbin.com'
   

   成功返回response，意味着 Kong 转发了请求到 我们第一步中设置的upstream_url了，并给我们返回了信息回来。Kong 知道这么做的原因是通过我们上边请求中定义的 --header

启动插件

Kong 的核心部分就是通过插件的高扩展性。通过插件可以容易在 API 上添加新的功能或者让你的 API 易于管理、

给 API 配置插件

$ curl -i -X POST \
  --url http://localhost:8001/apis/mockbin/plugins/ \
  --data 'name=key-auth'
# 给之前创建的mockbin的 API 添加插件
# 这个插件接收一个 config.key_names 的参数，默认值是：apiKey. 它是在headers和 parameters names(两种都支持)

验证这个插件是否正确的配置

$ curl -i -X GET \
  --url http://localhost:8000/ \
  --header 'Host: mockbin.com'
  
# 如果没有在 header 或者 parameters里指定 apiKey, 这个请求返回 403 Forbidden

添加消费者（Consumers）

上一个section说了怎么添加插件到Kong，这个 section 将学会怎么添加消费者到 Kong 的实例中。

消费者是关系到谁访问你的 API的时候，可以用来tracking\access management等等。

通过 API 创建一个消费者

$ curl -i -X POST \
  --url http://localhost:8001/consumers/ \
  --data "username=Jason"
  
# Kong 可以接收一个 custom_id 的参数，用来创建消费者的时候关联已存在的用户数据库

为消费者设定一个 key 凭证

$ curl -i -X POST \
  --url http://localhost:8001/consumers/Jason/key-auth/ \
  --data 'key=ENTER_KEY_HERE'

验证创建的消费者凭证是否有效

$ curl -i -X GET \
  --url http://localhost:8000 \
  --header "Host: mockbin.com" \
  --header "apikey: ENTER_KEY_HERE"