包括API的创建、修改、调试、发布、下线和删除等完整生命周期管理功能。

1 创建API

创建API操作需要定义API的基本信息、请求信息、后端服务信息、返回结果信息。创建完成的API仅为一份API定义，无法直接调用，需要使用发布功能发布至具体环境后方可调用。

1.1 配置API基本信息

• API名称：同一区域，同一项目内不重复。

• 所属分组：指明API所属分组，请在创建API前完成创建分组。

• 类型：公开类型，且在RELEASE环境上发布的API可以上架订阅。

• 安全认证：调用API时的认证方式。Appkey & Appsecret安全级别高，推荐使用。

• 权限等级：分为普通和高级。高级接口，API调用方需先申请，待API提供者审批通过后才能使用。

• 描述：对API进行基本描述。

1.2 定义API请求信息

API请求信息描述了API的调用者如何对当前API发起请求，包括请求方式和请求参数。

1.2.1 请求方式

• 域名：API网关统一提供的对外访问的域名，暂不支持自定义域名。

• 请求协议：支持HTTP和HTTPS。

• 请求PATH: 请求path可以包含请求参数，请求参数使用:标识，例如/a/:b，也可以通过配置"*"号做前缀匹配，例如: /a/*，默认会自动加上分组路径。

• 匹配模式：包含绝对匹配和前缀匹配。

① 绝对匹配：调用的请求Path固定为创建时填写的API请求Path。

② 前缀匹配：调用的请求Path将以创建时填写的API请求Path为前缀，支持接口定义多个不同Path。例如，请求路径为/foo/bar，使用前缀匹配时，通过/foo/bar/yy/zz可以访问，但是通过/test/baryyzz无法访问。

说明：使用前缀匹配时，匹配剩余的路径将透传到后端。例如，使用前缀匹配，前端请求路径定义为/foo/，后端请求路径定义为/foo1/，通过/foo/AA/CC访问API，则后端收到的请求url为/foo1/AA/CC。

• 访问方式：支持GET、POST、DELETE、PUT、HEAD、PATCH、OPTIONS、ANY，ANY表示任意Method。当Method为POST、PUT、PATCH时需要配置请求Body相关内容。

• 支持跨域: 是否开启跨域访问CORS（cross-origin resource sharing）。

CORS允许浏览器向跨域服务器，发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。

CORS请求分为两类：

① 简单请求：头信息之中，增加一个Origin字段。

② 非简单请求：在正式通信之前，增加一次HTTP查询请求(开启CORS后将为API添加OPTIONS method)。

1.2.2 请求参数

• 参数名称：发起API调用时需要使用的参数名称，不可重复。

• 参数位置：支持PATH、QUERY、HEADER。

• 类型：支持STRING，NUMBER类型。

• 必填：参数是否必填，设置成必填后，若实际请求时没用该参数，则请求会被拒绝。

• 描述：参数的描述。

注意：当请求PATH中包含了PATH路径参数时，须在后端服务参数列表中也定义相同名称的后端服务参数。

1.2.3 定义后端服务信息

API后端服务信息描述了API开放者提供的服务相关信息，包括后端请求方式、后端请求参数。后端服务支持HTTP和HTTPS两种类型，需要配置不同后端请求方式。

① 配置后端服务

• 后端名称：默认为 默认后端。

• 请求协议：支持HTTP和HTTPS。

• 请求方式：支持GET、POST、DELETE、PUT、HEAD、PATCH、OPTIONS、ANY，ANY表示任意Method。当Method为POST、PUT、PATCH时需要配置请求Body相关内容。

• 后端服务类型：默认为网络地址。

• 后端服务地址：指名后端资源所在主机的地址，支持域名、IP形式，不可重复。

• 权重值：指名多后端地址轮询时，当前地址的权重，取值为1~100之间的整型值，默认为1。当具有多个后端地址时生效。

• 后端分发策略：支持按次轮询和按权重轮询2种方式。

• 请求PATH：请求path可以包含请求参数，用:标识，比如/getUserInfo/:userId，支持 *%-_. 等特殊字符。

• 后端超时：默认5000ms。

② 配置后端请求参数

建立和请求入参的映射关系，可通过导入入参定义按钮进行批量添加，也可单独通过添加后端参数映射按钮进行添加。

• 入参名称：选择在第一二阶段配置请求入参的参数信息。

• 入参位置：自动填充。

• 入参类型：自动填充。

• 后端参数名称：后端服务需要使用的参数名称，不可重复。

• 后端参数位置：参数位置，支持PATH，QUERY和HEADER

注意：当请求PATH中包含了PATH路径参数时，须在后端服务参数列表中也定义相同名称的后端服务参数。

1.2.4 定义返回结果

成功或者失败调用API时，返回的响应信息示例。

API创建完成后，在API列表页面单击API名称，查看API详细信息。

2 修改API

点击列表操作列的“更多-修改”按钮，可进入API修改界面。各配置规则与创建API相同。

注意：对API进行修改，不会对已发布的API版本造成影响。如需当前修改在API调用者请求时生效，则需在修改后进行再次发布。

3 删除API

点击列表操作列的“更多-删除”按钮，可直接删除API。也可以在列表勾选后批量删除。

注意：在删除当前API之前需要确保所有环境中该API已下线。

4 发布API

API定义需要发布至具体环境中使定义生效，API调用者可在对应环境中调用该API。目前只支持默认的RELEASE环境。在API列表中勾选后，点击发布按钮可进行批量发布。也可点击操作列种的发布按钮逐个进行发布。

注意：一个API在一个环境中只能存在一个发布的版本，当多次发布时，最近一次发布版本会覆盖先前生效的版本。

5 调试API

API创建后如要验证服务是否正常，管理控制台提供在线调试功能，可以添加HTTP头部参数与body体参数，调试API接口。如果API已绑定流控策略，在调试API时，流控策略无效。不同类型的请求，调试页面的展示信息稍有不同。进入调试页面有多种路径。

路径一：进入API管理页面，查看列表，点击操作列“更多-调试”。

左侧为调试API时的输入信息，包含API的协议，请求方法，路径，以及参数。这些信息与创建API时输入的信息类似。点击发送请求后，右侧会展示调试该API的Response信息。

• 调用成功时，返回HTTP状态码为“200”和Response信息。

• 调试失败时，返回HTTP状态码为4xx或5xx。

注意：此种方式的调试，API不会通过API网关转发到后端的服务，而是由管理控制台直接转发请求到后端的服务。

路径二：进入应用管理-应用详情列表，点击列表操作列中的调试

展示信息整体和和路径1展示的类似。左侧信息增加了 应用的AppKey和AppSecret信息的调试信息。

注意：此种方式的调试，API会通过API网关转发到后端的服务。

路径三：进入订阅API—已订阅详情，点击API列表右侧操作列中的调试。

进入调试页面后，展示信息与路径2相同。

6 授权API

API在创建并发布后，通过指定授权给某些应用，让指定应用能够调用API。

6.1 添加授权

可针对单个API进行授权，也可以勾选多个API进行批量授权。

可查看所选中的API的已授权数据。每个API都可以展示所授权的APP列表。

点击“添加授权”按钮，进入添加授权页面

• API授权环境：选择一个API的发布的环境。目前暂只支持RELEASE环境。

• 自有应用：自己租户内创建的应用。

• 全局搜索：跨租户搜索所有应用。需要输入应用ID，完全匹配，多个以逗号分隔，最大支持100个应用ID。

6.2 解除授权

可对具体某个API所授权的APP进行解除。解除授权后，该应用将无法再调用该API。