全部产品

API 属性说明

更新时间:2020-04-21 14:25:39

本文将列出在 API 网关控制台创建并发布 API 时,您需要配置的相关属性。

API 定义

基本信息

属性 必填项 说明
API 名称
  • 用于识别 API。
  • 支持中文、英文、数字、_、-,且只能以英文和中文开头。最长 32 个字符。
  • 同一个 API 分组下 API 名称不能相同。
API 分组
  • 用于将 API 进行逻辑的分组,分组下的 API 相同的分组 ID 进行隔离。
  • 同一个环境下,API 分组名称不能相同。
  • API 分组名称:支持英文字母、中文、数字、_、-,32 个字符以内。
API 描述 用于描述 API 的作用等,64 个字符以内。
OperationType
  • 针对 mPaaS 移动应用设置的 API 服务标识,用于定位要访问的资源。
  • 支持英文字母、数字、.,200 字符以内。
  • 需按照 com.xxx.opt1 的格式输入。
请求路径
  • 表示请求的资源的 URL,通过请求路径可以定位到要请求的资源。
  • 支持英文字母、数字、 - 、_,200 字符以内。
  • 以斜杠 / 开头,不能以斜杠 / 结尾,格式示例 :/getUserInfo。
HTTP 方法 表明要对给定的 HTTP 资源执行的操作:
  • GET:检索服务器中的数据。
  • POST:将数据发送到服务器进行处理。
  • PUT:更新服务器中存储的数据。
  • DELETE:删除服务器中的数据。
接口名称
  • API 接口名称,支持英文字母、数字、. 、: 、@,以小写字母作为开头。
  • 格式示例: com.alipay.testapp.facade.ConfigFacade:1.0@DEFAULT
方法名
  • API 服务方法名,支持英文字母、数字组成,以字母作为开头。
  • 格式示例: getUserID
报文类型 表示请求和响应中的媒体类型信息,用来告诉服务端如何处理请求的数据,以及告诉客户端(一般是浏览器)如何解析响应的数据。
报文编码 表示客户端接受什么字符集的文本内容。

请求参数

请求参数表示客户端向网关发起请求时要配置的参数。

属性 必填项 说明
参数名 参数的唯一标识。
参数位置
  • Header:自定义 API 请求头。例如 X-MyHeader: Value
  • Path:参数为请求 URL 路径的一部分。例如 /users/{id}
  • Query:参数在请求 URL 末尾的问号 ? 之后以 name=value 形式出现。参数之间以 & 分隔。例如 /users?role=admin&id=12345
类型
  • String
  • Int
  • Long
  • Double
  • Float
  • Boolean
是否必填
默认值 在 API 请求的参数值为空时使用的默认值。 默认值类型必须和参数类型一致。
描述 参数的业务描述。

响应参数

属性 必填项 说明
成功响应示例 为 API 订阅者提供请求成功时的返回数据参考。
失败响应示例 为 API 订阅者提供请求失败时的返回数据参考。
错误码 HTTP 默认错误代码。
错误信息 自定义错误提示信息。
描述 错误码的业务描述。

后端配置

属性 必填项 说明
后端服务类型 表示网关接收到请求后转发给的后端服务类型:
  • Mock:表示如果接口后端还没有提供,使用 Mock 用于模拟一个后端服务。
  • 系统集群:表示网关接收到前端请求后转发到真实业务系统的集群。
后端协议类型 表示网关接收到请求后转发给的后端服务使用的通信协议类型:
  • HTTP
  • SOFARPC
  • MRPC
超时时间 API 请求超时时间,单位为毫秒(ms),默认 3000 毫秒。
路由策略 表示当网关接收到语法后使用的路由策略:
  • 根据 Header 路由:根据Header里带的参数路由
  • 根据权重路由:数值范围为 0-100,所有规则加起来为 100。
  • 根据请求路径/接口路由:直接转发