阿里云API网关创建、发布、授权、下线、删除、调试API步骤

API的完整生命周期包括:创建、发布、授权、下线、删除、调试等,阿里云云API网关产品为用户提供了与之对应的功能。
创建API
用户通过创建API功能实现开放后端服务操作,API创建主要分以下四个步骤:定义基本信息、定义API请求、定义API后端服务、定义返回结果。

步骤1:点击左侧【API管理】按钮进入API列表页,点击列表页面【创建API】按钮,进入API创建页面。选择API所属分组,认证方式(分为APP认证和无认证),填写API名称和描述,点击【下一步】。
说明:
1.如果选中无认证方式创建API,用户在调用API请求时,无需传入认证参数,出于安全考虑,不推荐用户使用这种方式创建API。
2.如果选中APP认证方式创建API,用户在调用API请求时,需要在请求头中传入APP信息,通过应用的APPKey和APPSecret等信息进行加密。

步骤2:定义API请求,设定API对外开放的请求信息,包括填写请求Path,HTTP Method方法,入参定义,请求body,点击【下一步】。
说明:
1.请求path指API对外开放的请求路径,请求path必须以/开头,请求路径可以包含动态参数,以[]标识;
2.支持四种请求方法,HTTP Method可设置为GET、POST、PUT、DELETE;2.支持三种参数的请求入参设置:参数位置包括Header、Query、Path;
3.提供参数类型设置,入参定义包括string、integer、long、float、double、boolean;
4.请求中的所有参数,包括Header、Query、Path,参数名称唯一,支持英文、数字、_、-,必须以英文或_开头,不能是x-apig开头,不能是Accept、Content-MD5、Content-Type、User-Agent、Date,请求参数的每个字段不可超过50字符;
5.当HTTP Method是PUT和POST,可输入body内容示例,最大长度为500字符,真实调用body参数长度无限制;
6.如果前端请求地址含有path参数,则入参参数列表项必须含有path参数,且为必填;

步骤3:设置后端基础定义,设置后端服务参数配置内容,点击【下一步】。
说明:
1.后端服务地址支持输入域名、ipv4、ipv6格式,域名最多支持3级域名,后端服务地址的格式为:host:port;
2.前端请求path中含有path参数,则后端服务参数列表必须含有path参数;
3.后端服务参数path所对应的前端入参是必填项;4.后端服务参数的名称和位置可编辑,对应入参名称、对应入参位置和对应入参类型为前端请求入参信息,在这一步骤中不可修改;5.后端服务的HTTP Method、body实例不可编辑,和前端请求保持一致;

步骤4:设置返回结果示例和返回失败接口示例,点击【创建】按钮,完成API的创建操作。发布API
实现对当前API指定环境的发布操作,API只有在指定环境发布之后,API调用者才能在对应的环境中进行调用。
步骤1:进入API列表页面,找到需要发布的API,点击API列表【发布】按钮,弹出API发布弹框。

步骤2:选择要发布的环境,并且填写描述,点击【确定】,完成API的发布操作。(目前支持2种发布环境:TEST,PRD)发布完成后运行环境展示(已发布)字样。API发布到具体的环境之后,在API调用时,需要传入环境参数进行校验。(后续版本会规划环境绑定具体的环境信息,实现环境信息管理功能)

步骤3:当某个API在TEST、PRD环境全部发布完成,再点击【发布】,提示暂无可发布环境。授权APIAPI在创建成功、发布成功之后,需要将API授权给指定的应用,让指定的应用实现API调用。API可授权给您创建的应用,也可以授权给其他阿里云用户创建的应用,阿里云其他用户创建的应用通过应用ID进行搜索。
步骤1:进入API列表页面,找到需要授权的API,点击API列表【授权】按钮,弹出API授权弹框。
步骤2:选择根据【应用名称】或者【应用ID】查询,在输入框填入查询信息,回车或者点击搜索按钮,刷新授权应用列表。

步骤3:在API授权弹框中选择授权环境、授权应用,点击【添加】按钮,点击【确定】完成API授权操作。下线API
实现对当前API在指定环境的下线操作,API在指定环境下线后,会导致API无法调用。
步骤1:进入API列表页面,找到需要下线的API,点击API列表【下线】按钮,弹出API下线弹框。
步骤2:选择要下线的环境,点击【确定】,完成API的下线操作,取消“已发布”字样
步骤3:当API环境全部下线,再点击【下线】按钮,提示:暂无可下线的环境,请先发布

删除API
如果API不再提供服务,可实现API的删除操作,删除当前API之前,需要保障该API在全部环境中已下线。
进入API列表页面,找到需要删除的API,点击API列表【删除】按钮,弹出确认删除弹框,提示“确认删除某某API吗?”,点击【确定】,完成API的删除操作。当API在某个环境中未下线,则不可删除,给出提示信息:“该API还未完全下线,请将所有环境中的API全部下线后再进行删除操作”。调试API云API网关产品提供API调试页面,您可以在API调试页面完成API调试操作,检查API是否正确开放。
步骤1:进入API列表页面,找到需要调试的API,点击API列表【调试】按钮,跳转至API调试页面。
步骤2:进入API调试页面,填入相关信息,点击【发送请求】进行调试操作。
API需要先在某环境完成发布,再进行调试。对于未发布的API,进入API调试页面,弹出友好提示:“目前某某API未发布,是否确定先发布API?”,点击【立即前往】,首先完成API发布,再进行调试。

如果API是无认证方式,通过控制台API调试页面进行调试,API无需进行授权,即可实现API调试。
如果API是APP认证方式,且当前API在某环境已发布但是未授权给应用,进入API调试页面,弹出友好提示:“API在TEST/PRD环境下未授权应用,是否确定先授权?”,点击【立即前往】,首先完成API授权,再进行调试。说明:
1.API调试可以通过控制台页面的API调试页面进行调试;或者通过postman及其他接口调用工具进行调试,需要传入X-Apig-Mode参数,且值为debug。
2.如果API是无认证方式,通过控制台API调试页面进行调试,API无需进行授权,即可实现API调试;如果通过postman及其他接口调用工具进行调试,仍然需要完成APP授权后进行调试。
3.一个API在某个环境下,一天最多允许调试1000次。

API管理
API管理包括:API定义、授权信息、发布历史、已绑策略。
(1)API定义:展示API定义的详情信息,支持对API进行编辑。
(2)授权信息:展示API绑定的授权信息,并提供对API的添加授权和解除授权功能。
(3)发布历史:展示API的历史发布日志记录。
(4)已绑策略:展示API绑定的策略信息,包括流量控制、签名密钥和访问控制策略,并提供对API的绑定策略和解绑策略功能。

API管理-API定义
步骤1:进入API列表页面,找到需要查看的API,点击API列表【管理】按钮,进入API管理页面。默认进入API定义页面,API定义页面展示API详细信息。
步骤2:API管理的API定义页面,展示该API的详细信息,包括名称及描述、请求基础定义、请求入参信息、请求body、后端服务信息、后端参数信息和返回结果,同时提供API编辑操作。点击页面右上角【编辑】按钮,进入编辑API页面,API的编辑过程中,API所在分组置灰不可编辑。
API编辑成功之后立即生效,无需再重新发布该API、重新授权以及重新绑定策略。

API管理-授权信息
API管理的授权信息页面,列表展示该API的授权信息,列表信息包括应用ID、应用名称、环境和授权时间,同时提供根据应用名称或应用id查询该API授权的应用,添加授权和解除授权操作。API管理的授权信息页面,提供API授权应用的操作,点击【添加授权】按钮,弹出授权弹框,完成授权操作。
API管理的授权信息页面,点击授权列表复选框(可多选),再点击【解除授权】按钮,弹出解除授权弹框,点击【确定】,完成解除授权操作。
API管理-发布历史
API管理的发布历史页面,列表展示该API的发布历史信息,列表信息包括发布版本、发布备注、环境和发布时间。
API管理-已绑策略
API管理的已绑策略页面,展示该API的绑定策略情况,点击页面策略tab按钮,可查看API绑定的流量控制策略、签名密钥策略和访问控制策略,同时提供API绑定/解绑策略的操作。
下面以API绑定/解绑的流量控制策略为例子:
点击【绑定流控策略】,弹出绑定弹框,选择该API需要绑定的环境、单次勾选某流控策略,点击【确定】完成绑定。如果该API在某环境上原来已经绑定一个策略,会被本策略覆盖,请谨慎选择!
点击列表页面【解绑】,弹出解绑二次确认弹框,完成解绑策略。