创建API分为4个步骤:
步骤 1在左侧导航栏选择“开放API > API管理”。
步骤 2单击“新建API”,设置API基本信息。
设置基本信息
参数 | 配置说明 |
---|---|
API名称 | 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。 |
所属分组 | 默认创建API分组中已创建分组。 |
网关响应 | API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。 |
类型 | 默认“公开”。 |
安全认证 | 选择API认证方式,此处选择“APP认证”。 |
支持简易认证 | 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处开启简易认证, |
标签 | 标签主要用于对API添加分类属性,方便在创建了大量API后,快速过滤和查找。 |
描述 | API的描述。 |
步骤 3单击“下一步”。
步骤 1在“定义API请求”页面,配置API请求信息。
定义API请求
参数 | 配置说明 |
---|---|
域名 | 创建API分组时,系统默认分配的一个子域名。 |
请求协议 | 选择API请求协议,此处选择“HTTPS”。 |
请求Path | 接口请求的路径。 |
匹配模式 | 默认“绝对匹配”。 |
Method | 接口调用方式,此处选择“POST”。 |
支持CORS | 为方便起见,此处不开启。 |
步骤 2单击“下一步”。
步骤 1在“定义后端服务”页面,配置后端服务信息。
步骤 2选择后端服务类型,此处选择“HTTP/HTTPS”。
HTTP/HTTPS类型定义后端服务
服务参数 | 参数说明 |
---|---|
协议 | 选择协议类型,此处选择“HTTP”。 |
请求方式 | 接口调用方式,此处选择“POST”。 |
使用VPC通道 | 选择“不使用”VPC通道访问后端服务。 |
后端服务地址 | 后端服务的地址。 |
后端请求Path | 后端服务的路径。 |
后端超时 | 后端服务请求的超时时间。此处默认“5000”ms。 |
后端认证 | 后端服务对API调用增加自己的认证。为方便起见,此处不开启。 |
步骤 3单击“下一步”。
步骤 1在“返回结果基础定义”页面,定义返回结果。
定义返回结果
信息项 | 描述 |
---|---|
成功响应示例 | 成功调用API时,返回的响应信息示例。 |
失败响应示例 | 调用API失败时,返回的响应信息示例。 |
步骤 2单击“完成”,完成API的创建。