通过网关访问的完整请求地址为 网关IP:端口号/网关别名/策略组id/接口路径
下面将介绍通过配置文件快速使用 GoKu API Gateway CE 。
一.创建网关
- 1、打开全局配置文件 goku.conf ,输入以下信息:
1.host: ""
2.port: "6600"
3.gateway_conf_path: ./config/gateway
- 2、打开网关配置文件 gateway.conf ,输入以下信息:
1.gateway_name: 示例网关
2.gateway_alias: asp
3.gateway_status: on
4.ip_limit_type: none
5.api_group_conf_path: ./config/gateway/asp/api_group.conf
6.api_conf_path: ./config/gateway/asp/api.conf
7.strategy_conf_path: ./config/gateway/asp/strategy.conf
8.backend_conf_path: ./config/gateway/asp/backend.conf
二.添加后端服务
打开后端服务配置文件 backend.conf ,输入以下信息:
1.backend:
2.- backend_id: 1
3. backend_name: apishop
4. backend_path: https://api.apishop.net
三.新建策略组
每个网关下可以新建多个策略组,策略组包含 鉴权方式、流量控制、IP黑白名单 等模块,一个策略组可以指定多个 API组,API请求地址务必加上相应的 策略组id 。
在此采用无鉴权的方式、无ip黑白名单、流控为1次/秒,打开策略组配置文件 strategy.conf ,输入以下信息:
1.strategy:
2.- strategy_name: 示例策略
3. strategy_id: test
4. auth: none
5. ip_limit_type: none
6. rate_limit_list:
7. - allow: true
8. period: "sec"
9. limit: 1
10. priority: 999
11. start_time: 0
12. end_time: 24
四.新建API分组
打开API分组配置文件 api_group.conf ,输入以下信息:
1.group:
2.- group_id: 1
3. group_name: 示例分组1
4.- group_id: 2
5. group_name: 示例分组2
五.新建API
在此使用 接口商店 (apishop.net) 的 全国油价查询API 作为要通过网关访问的示例接口,下面的教程展示如何在GoKu网关配置该接口。
该接口的请求参数如下:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
apiKey | long | 是 | 申请数据后可在apishop控制台查看 |
province | text | 否 | 省份名,比如广西、北京 |
打开API配置文件 api.conf ,输入以下信息:
1.apis:
2.- api_name: 全国油价
3. group_id: 1
4. backend_id: 1
5. request_method:
6. - post
7. - get
8. request_url: /common/oil/getOilPriceToday
9. proxy_method: post
10. proxy_url: /common/oil/getOilPriceToday
11. proxy_body_type: formdata
12. porxy_body:
13. proxy_params:
14. - key: province
15. key_position: body
16. not_empty: false
17. proxy_key: province
18. proxy_key_position: body
19. constant_params:
20. - key: apiKey
21. position: body
22. value: Uad5kkL53ced1ca67f*****************
六.访问网关
通过网关访问的完整请求地址为 网关IP:端口号/网关别名/策略组id/接口路径
所以该API通过网关的完全请求路径为
http://localhost:6600/asp/test/common/oil/getOilPriceToday
在此使用 eoLinker接口管理平台 进行测试。
发送请求后得到正确结果:
至此,您已成功了解GoKu API Gateway CE,如您在使用过程中依然存有问题,欢迎各位加入我们的用户讨论群,我们的技术同事将会为您解答:用户交流1群 (群号:725853895) 。
想了解更多国内首款GO语言网关信息,请留意:https://agw.eolinker.com,或者关注本博客,博客将会及时更新eoLinker旗下产品最新资讯。
相关文章:
国内首款GO语言网关!GoKu API Gateway部署指南
GoKu API Gateway CE 配置文件
GoKu API Gateway CE golang安装与设置