创建API
- 创建API分组。
API网关>开放API>右上方创建分组。
编辑分组
填写分组名称(自定义),带年纪确定完成创建。
- 创建API。
进入API分组,创建API,API提供erp数据上传的请求转发功能。
创建过程说明:
1. 基本信息。
API名称:自定义。
所属分组:默认。
网关响应:默认。
类型:公开。
安全认证:App认证。
其他根据需要填写,没有则默认。
2. 定义API请求。
域名:默认。
请求协议:根据需要选择。
请求path:
IT应用发送数据的请求地址:/orders
匹配模式:绝对匹配。
Method:POST(根据请求方式选择)。
入参定义:
对于带有参数的请求需要声明入参定义,如请求path为"/configs/{ia_id}",则入参定义为:
参数名:ia_id
参数位置:path
3. 定义后端请求。
后端服务类型提供了三种方式。
后端服务类型选择HTTP/HTTPS时的配置:
协议:根据北向应用NA使用的协议填写。
请求方式:根据北向应用NA定义的请求方式填写。
vpc通道:根据需求选择。
Virtual Private Network,虚拟专用网络。在公用网络上建立专用网络,进行加密通讯。在企业网络中有广泛应用。VPN网关通过对数据包的加密和数据包目标地址的转换实现远程访问。VPN可通过服务器、硬件、软件等多种方式实现。
后端服务地址:北向应用NA接收请求的ip或域名。
后端请求Path:北向应用NA接收请求的地址。
后端超时:自定义。
后端服务地址和后端请求Path很重要,这两项决定NA的请求地址。
后端服务类型选择Mock时的配置:
定义后端请求即定义API网关接收的请求将转发的位置,可通过Mock模拟后端响应。
Mock返回结果:此处定义的内容会被返回到请求端。(非必填)
返回示例:
{ "configs": [ { "id": "config1203", "name": "config1202", "value": "config1202", "description": "config1202", "version": "1606878222614", "state": "SUCCESS", "create_time": "2020-12-02T03:02:42Z", "update_time": "2020-12-16T08:44:33Z" } ] }
使用mock不能显示请求携带的数据,只能接收到请求后返回定义的结果。
4. 定义返回结果
成功响应示例:自定义。
失败响应示例:自定义。
5. 发布API
将创建的API发布到release环境。
API网关>API分组>选择创建的API分组>API管理>勾选创建API>单击发布。