API路由是访问上游目标的路径,在API安全网关中,路由首先通过预定的规则来匹配客户端请求,然后加载和执行相应的插件,最后将请求转发至特定的服务。
创建API
1.登录API安全网关。
2.在左侧导航栏选择“资源 > API”,进入API列表页面。
3.单击页面左上角的“新增”按钮,开始新增API。
字段 | 说明 |
---|---|
API基本信息 | |
关联服务 | 为该API选择一个关联的服务,该API会新增在对应服务目录下。 说明 API需要关联到具体的服务,如何创建服务请参考:服务章节。 |
API名称 | 填写API路由名称,不允许重复。 |
描述 | 填写API路由的描述。 |
发布 | 发布的API允许访问。 |
协议 |
|
API版本 | 填写API路由版本,管理不同版本的API,使得新旧版本可以并行存在且互不影响,方便客户端平滑升级。 |
匹配条件 | |
路径 | HTTP请求路径,如/foo/index.html;支持请求路径前缀/foo/*、/* 代表所有路径,支持添加多条 |
HTTP方法 | 匹配指定的HTTP方法 |
优先级 | 默认0,数字越大,优先级越高 |
高级匹配条件 | |
高级匹配条件 | 参数位置:支持选择HTTP请求头、请求参数、POST请求参数、Cookie、内置参数。 参数名称:自定义参数名称。 非(!):开启是否取反。 运算符:选择运算符。 参数值:填写参数值,具体请根据您选择的参数位置决定。 |
4.配置完成后,单击“下一步”,进入“配置请求处理”。
字段 | 说明 |
---|---|
请求改写 | |
路径改写 |
|
域名改写 |
|
HTTP方法改写 |
|
请求头添加 | 输入请求头的参数名和参数值,添加指定请求头。 |
请求头改写 | 输入请求头的参数名和参数值,将指定请求头的值改写。 |
请求头移除 | 输入请求头参数,删除指定参数。 |
5.配置完后单击“下一步”进入配置返回处理步骤。
字段 | 说明 |
---|---|
配置返回处理 | |
API调用者 |
|
新增脱敏策略 | 根据配置的标签和算法进行脱敏。 |
6.添加完成后,单击“下一步”,进入插件配置环节,具体的插件功能请参照控制台说明,若需要启用插件单击对应插件下方的“启用”按钮即可启用。
7.完成插件配置后,单击“下一步”确认API信息,若信息无误单击“保存”即可完成添加API。
导入/导出API
1.登录API安全网关。
2.在左侧导航栏选择“资源 > API”,进入API列表页面。
3.单击页面上方的“导入/导出API”按钮。
4.在弹出的对话框中选择YAML或JSON文件导入即可。
说明
目前仅支持YAML、JSON两种文本格式的描述文件。
导入已存在的API会默认跳过,最多可创建50个API。
上传的文件将覆盖编辑器中的内容,文件大小不可以超过100KB。
后续操作
生命周期管理:选择需要上线/下线的API,单击“操作”列的“上线/下线”按钮即可上线/下线API。
配置API:选择需要配置的API,单击“操作”列的“配置”按钮即可配置API。
删除API:选择需要删除的API,单击“操作”列的“删除”按钮即可删除API。
查看API:选择需要查看的API,单击“操作”列的“更多 > 查看”按钮即可查看API。
克隆API:选择需要克隆的API,选择“操作”列的“更多 > 克隆”按钮即可克隆API。