更新时间:2022-08-04 GMT+08:00
分享

创建API

创建API步骤:

  1. 前端配置
  2. 后端配置

前端配置

  1. 在左侧导航栏选择“API管理 > API列表”。
  2. 单击“创建API”,配置前端定义。

    表1 前端定义

    参数

    配置说明

    API名称

    填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。

    所属分组

    默认创建API分组中已创建分组。

    URL

    请求方法:接口调用方式,此处选择“POST”。

    请求协议:选择协议类型,此处选择“HTTPS”。

    子域名:创建API分组时,系统默认分配的一个子域名。

    路径:接口请求的路径。

    网关响应

    API网关未能成功处理API请求,从而产生的错误响应。

    默认的网关响应为“default”。

    匹配模式

    默认“绝对匹配”。

    标签

    标签主要用于对API添加分类属性,方便在创建了大量API后,快速过滤和查找。

    描述

    API的描述。

  3. 根据下表参数信息,配置安全配置。

    表2 定义API请求

    参数

    配置说明

    安全认证

    选择API认证方式,此处选择“APP认证”。

    支持简易认证

    简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。

  4. 单击“下一步”。

后端配置

  1. 在“后端配置”页面,配置后端服务信息。
  2. 选择后端服务类型,此处选择“HTTP/HTTPS”。

    表3 HTTP/HTTPS类型定义后端服务

    服务参数

    参数说明

    使用VPC通道

    选择“不使用”VPC通道访问后端服务。

    URL

    请求方法:接口调用方式,此处选择“POST”。

    请求协议:选择协议类型,此处选择“HTTP”。

    后端服务地址:后端服务的地址。

    路径:后端服务的路径。

    后端超时

    后端服务请求的超时时间。此处默认“5000”ms。

  3. 在“返回结果基础定义”页面,定义返回结果。

    表4 定义返回结果

    信息项

    描述

    成功响应示例

    成功调用API时,返回的响应信息示例。

    失败响应示例

    调用API失败时,返回的响应信息示例。

  4. 单击“完成”,完成API的创建。
分享:

    相关文档

    相关产品

close