API 测试术语表

The concepts these APIs exercise, each defined in a paragraph and then demonstrated by an endpoint you can call. Every entry names the misconception people actually hold about it, because that is usually the part standing between reading the definition and getting it right.

A

API 端点
一个 URL 加上一个 HTTP 方法——客户端可以调用的最小 API 单元。
API网关
在一个或多个服务前端提供一个单一入口点,用于处理路由、身份验证、速率限制和日志记录。
API密钥
一个静态的密钥字符串,用于标识调用应用程序,并随每个请求一起发送。
API 沙箱
API 的一个独立副本,其中调用不会产生任何实际影响,数据可以重置。
API 版本控制
并行运行多个版本的 API,因此重大变更不会破坏现有客户端。
身份验证与授权
身份验证证明你的身份;授权决定你被允许做什么。

B

基本身份验证
每次请求都会发送用户名和密码,并在 Authorization 标头中进行 Base64 编码。
批量请求
一个请求包含多个操作,每个操作返回一个结果。
Bearer 令牌
一种凭证,持有者即可获得访问权限——谁持有它就可以使用它。
边界值分析
选择在允许范围边缘和附近进行的测试输入,因为偏一错误就存在于这些边缘。

C

缓存控制
该标头告诉浏览器、CDN 和代理服务器是否可以存储响应、由谁存储以及存储多长时间。
客户凭证授权
一个服务调用另一个服务的 OAuth 流程:客户端用自己的 ID 和密钥交换访问令牌。
内容谈判
客户端和服务器通过标头而不是单独的 URL 来约定响应格式。
合同测试
测试 API 及其使用者是否在请求和响应的形式上达成一致,而无需同时运行它们。
CORS
决定一个源上的 JavaScript 是否可以读取另一个源的响应的浏览器规则。
卷曲
用于发出 HTTP 请求的命令行工具,以及用于共享精确 API 调用的通用语言。

D

弃用和终止标头
响应头会警告客户端某个端点即将关闭,以及何时停止工作。

E

ETag
用于表示形式的不透明版本标识符,用于避免重新发送该表示形式并检测冲突的写入。
指数退避
一种重试策略,其中每次等待时间都比上一次更长,并添加随机性,以防止客户端同步重试。

F

故障注入
故意引入故障——错误、延迟、垃圾响应——来测试系统的应对能力。
不规则测试
一个测试,有时通过,有时失败,而测试的代码没有任何改动。

G

GraphQL
一种用于 API 的查询语言,客户端可以通过单个端点准确地指定所需的字段。

H

仇恨
超媒体作为应用程序状态的引擎——响应包含指向您接下来可以执行的任何操作的链接。
HMAC签名
一个带有密钥的哈希值证明有效载荷来自持有共享密钥的人,并且没有被篡改。
HTTP 标头
每个请求和响应都会发送名称-值元数据,与请求体分开。
HTTP 状态码
每个 HTTP 响应开头的三位数,在响应体之前,表示发生了什么。

J

JSON补丁
用于将 JSON 文档的更改描述为操作列表的标准格式 (RFC 6902)。
JSON 模式
用于描述有效 JSON 文档外观的 JSON 词汇表,以便可以自动验证文档。
JWKS
JSON Web 密钥集——发行者发布的公钥,以便任何人都可以验证其签名的代币。
JWT(JSON Web Token)
以签名 JWS 或加密 JWE 形式表示声明的紧凑格式。

M

媒体类型(内容类型)
标签(例如 application/json)表示正文的格式,该标签包含在 Content-Type 中。
模拟 API
一个可以替代真实 API 的方案,它能够返回逼真的响应,但背后却没有真实的系统支持。
赝品、存根和假货
三种类型的测试替身——真实依赖项的替代品——它们在执行的操作和检查的内容上有所不同。
multipart/form-data
用于在单个请求中上传文件和表单字段的请求正文格式。

O

OAuth 2.0
该标准框架允许应用程序获取有限的访问令牌,而不是处理用户的密码。
OAuth 范围
附加到访问令牌的命名权限,用于限制其用途。
OpenAPI
HTTP API 的机器可读描述——包括其路径、参数、主体和响应——以 JSON 或 YAML 格式表示。
OpenID Connect
在 OAuth 2.0 之上的身份层,通过签名 ID 令牌告诉客户端用户是谁。

P

路径参数
URL 路径中的可变部分,例如/orders/42中的 42,用于标识一个特定的资源。
PKCE
代码交换证明密钥——一次性密钥,可防止被盗的 OAuth 授权码被其他人兑换。
邮差收藏
一组已保存、可共享的 API 请求(包含其标头、正文、变量和测试),采用 Postman 的 JSON 格式。
PUT 与 PATCH
PUT 参数将资源替换为您发送的表示形式;PATCH 参数将一组更改应用到该资源。

Q

查询参数
URL 中问号后面的键值对,用于过滤、排序、分页或调整端点返回的内容。

R

范围请求
只请求资源的一部分(字节范围),以便下载可以恢复,媒体可以进行搜索。
刷新令牌
仅用于获取新的短期访问令牌的长期凭证,无需用户再次登录。
请求 ID(关联 ID)
请求及其日志会附加一个唯一标识符,以便可以追踪一次调用所涉及的每个服务。
请求超时
客户端在放弃请求之前等待响应的最长时间。
资源状态机
一种资源,它在已定义的状态(创建、发货、交付)之间转换,其中只允许某些转换。
REST API
将系统建模为可寻址资源的 API,可通过标准 HTTP 方法进行操作。
重试后
响应头告诉客户端在重试之前要等待多长时间,以秒或日期为单位。

S

安全且等效的方法
HTTP 方法的两个独立属性决定了客户端可以重试哪些方法。
服务器发送事件 (SSE)
通过普通的 HTTP 响应,从服务器到客户端单向传输事件流,并且响应保持打开状态。
烟雾测试
在进行任何更彻底的检查之前,先运行一组简短快速的检查,确保最重要的路径都能正常工作。
软删除
将记录标记为已删除而不是将其删除,这样 API 就可以说它已经消失了,而不是说它从未存在过。

T

测试夹具
测试开始时的已知数据和状态,每次运行都以相同的方式设置。

W

Webhook
服务器在发生某些事情时向您发送的 HTTP 回调,而不是让您轮询询问。

阅读英文版

测试技巧 · 全部 HTTP 状态码 · 全部 55 个模拟 REST API

最后更新时间