Kong API Gateway服务使用说明
1. 简介:
Kong 是在客户端和(微)服务间转发API通信的API网关,通过插件扩展功能。 Kong 有两个主要组件: Kong Server :基于 nginx 的服务器,用来接收 API 请求。 Apache Cassandra :用来存储操作数据。 Kong的主要功能: Kong可灵活扩展:只要增添更多的服务器实例,它就能横向扩展,毫无问题,那样你可以支持更多流量,同时确保网络延迟很短。 Kong可在任何地方运行:它可以部署在单个或多个数据中心环境的私有云或公有云上 Kong具有模块性:它可以与新的插件协同运行,扩展基本功能。可将你的API与许多不同的插件整合起来,以增强安全、分析、验证、日志及/或监测机制。
2. 版本:
当前订阅的Kong API Gateway服务的版本:0.10.1
3. 订阅及使用说明:
1 Kong服务订阅
参考寄云应用开发与数据分析平台使用手册完成Kong服务的订阅,订阅过程中,可以输入Kong服务的服务名称。
2 Kong服务管理
1)管理应用的创建:
通过源代码创建管理应用:
在订阅Kong服务后,需要为其创建NodeJS的管理应用,完成API的创建、修改、删除等管理操作。
Kong管理应用的代码源如下:
https://github.com/PGBI/kong-dashboard.git
参考寄云应用开发与数据分析平台使用手册,基于上述代码源,完成Kong管理应用(NodeJS应用)的创建工作。创建过程中,需要在第3步输入如下环境变量:
NPM_RUN_BUILD=true
输入后务必点击“添加”按钮,保证环境变量设置成功:
Kong管理应用创建完成以后,通过其应用详情页面右上方的“访问应用程序”按钮,进入到管理应用界面。
通过官方镜像创建管理应用: 在订阅Kong服务后,也可以通过kong-dashboard官方镜像创建管理应用,官方镜像地址:
docker.io/pgbi/kong-dashboard
参考寄云应用开发与数据分析平台使用手册,基于上述镜像地址完成Kong管理应用(通过Docker镜像地址创建应用)的创建工作。
Kong管理应用创建完成以后,通过其应用详情页面右上方的“访问应用程序”按钮,进入到管理应用界面。
2)管理应用的配置:
第一次打开管理应用时需要配置订阅的Kong服务的IP地址及管理端口参数,保存后,即可对API进行创建、修改、删除等管理操作。
3)API管理:
在管理应用主界面选择“Create An API”按钮,可以创建一个新的API。
在API创建页面输入相关的信息后,选择“CREATE”按钮即可完成创建操作。
其中:
Name: 该API的名称
Uris: 调用该API的URI路径
Upstream url: 该API转到的URL地址
创建完成后,在API列表右侧可以选择修改、删除等API操作。
3 Kong服务使用
在Kong API Gateway中设置的API,可以通过以下方式进行使用:
1)在浏览器中进行验证:
在浏览器中验证API的URL获取方法为:
首先,在服务详情中复制“管理服务”按钮的地址:
在此基础上,再加上API设置中的Uris部分:
才能形成完整的API调用地址:
调用该API后,将转移为访问www.163.com网站:
2)通过REST API客户端(或工具)调用:
可以通过REST API客户端(或工具)调用所需的API,API的调用URL同样采用第1)种方式合成:
3)通过代码调用:
在其它应用开发过程中,可以通过代码调用所需的API,API的调用URL同样采用第1)种方式合成。