文档

基础术语

更新时间:
一键部署

本文将对 API 网关中常见的基础术语进行说明。

中文

释义

API

应用程序编程接口,是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。

API 分组

用于将 API 进行逻辑的分组,同个分组下的 API 使用相同的分组标识做隔离。

分组标识

是网关全局的唯一标识,用于定位在访问的 API。

默认二级域名

客户端使用 HTTP 协议访问网关时使用,由分组标识+网关的二级域名组成。

SSL

安全套接字层,是一种标准协议,用于加密浏览器和服务器之间的通信。

前端协议类型

是指客户端请求到网关时使用的协议类型。

HTTP

超文本传输协议。

SOFARPC

蚂蚁集团自研的 RPC 调用框架。

请求路径

表示请求的资源的 URI(统一资源标识符,Uniform Resource Identifier),通过请求路径可以定位到要请求的资源。

绝对匹配

调用的请求路径固定为创建时填写的 API 请求 Path。

前缀匹配

只要请求路径前缀相同则都匹配到这个接口上,实现接口定义多个不同 Path。

HTTP 方法

表明要对给定的 HTTP 资源执行的操作。

请求参数

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

header 参数

报文头包含若干个属性,格式为“属性名:属性值”,服务端据此获取客户端的信息。

query 参数

一般是指 URL 中 ? 后面的参数。

请求 body 参数

指请求体中的数据。

响应参数

用于对响应内容进行解释。

响应 body 参数

用于解释响应体里的参数含义。

响应示例

用于示例响应的状态。

业务错误码

用于解释响应里的业务错误码代表的意思。

接口全名

RPC 接口的接口命名,就完成某些特定功能的类,是一个功能的集合。

RPC 方法

RPC 接口里的方法,表明要资源执行的具体操作。

OperationType

针对 mPaaS 移动应用设置的 API 服务标识,用于定位要访问的资源。

后端服务类型

表示网关接收到请求后转发给的后端服务类型。

后端协议类型

表示网关接收到请求后转发给的后端服务使用的通信协议类型。

报文类型

表示请求和响应中的媒体类型信息,告诉服务端如何处理请求的数据,以及告诉客户端(一般是浏览器)如何解析响应的数据。

报文编码

客户端接受字符集样式的文本内容。

MOCK

如果接口后端还没有提供,使用 Mock 用于模拟一个后端服务。

系统集群

表示网关接收到前端请求后转发到真实业务系统的集群。

地址配置方式

表示系统集群的地址来源。

集群地址

表示系统集群的地址,可以是 IP 地址,也可以是域名。

负载均衡

当后端地址大于 1 个时使用的负载均衡策略。

后端认证方式

表示网关向后端业务系统发送请求时是否要加签。

路由规则

表示当网关接收到语法后使用的路由策略。

应用

表示非 mPaaS 移动应用以外的应用。

mPaaS 移动应用

表示 mPaaS 移动应用,必须和 mPaaS 移动开发平台一起使用。