开发代理术语表

此术语表定义在整个开发代理文档中使用的术语。

A

API 模拟器

一种工具,用于模拟 API 的行为,而无需连接到真正的 API 服务器。 开发代理是一种 API 模拟器,可以模拟响应、模拟错误和注入延迟。

C

混沌测试

一种测试方法,故意将故障引入系统,以验证它是否可以处理意外情况。 开发代理通过模拟随机 API 错误和失败来启用混沌测试。

配置文件

定义开发代理行为的 JSON 文件(devproxyrc.json包括要监视的 URL、要启用的插件和特定于插件的设置)。 请参阅 “配置开发代理”。

E

错误模拟

故意使 API 调用失败,以测试应用程序如何处理故障。 开发代理通过返回 HTTP 错误响应而不是将请求转发到实际 API 来模拟错误。

I

Intercept

开发代理会在 HTTP/HTTPS 请求到达目标之前将其捕获。 截获的请求可以传递到 API、修改或替换为模拟响应。

L

延迟

发送请求和接收响应之间的时间延迟。 开发代理可以注入人工延迟,以模拟网络条件缓慢或 API 负载过重的情况。

M

模拟响应

开发代理返回的预定义响应,而不是将请求转发到实际 API。 模拟可用于针对尚不存在的 API 或需要可预测响应时进行测试。

模拟文件

包含模拟响应定义的 JSON 文件(通常 mocks.json)。 每个条目将 URL 模式映射到响应正文、状态代码和标头。

P

透传

当开发代理将请求转发到实际 API 时,无需修改。 当请求与任何活动插件不匹配或插件决定不对其执行作时,就会发生这种情况。

插件

扩展Dev Proxy功能的模块化组件。 插件可以截获请求、生成报告或提供指导。 请参阅 插件体系结构

Preset

适用于常见方案的预建配置文件。 预设结合了插件和设置来完成特定任务。 请参阅 “使用预设配置”。

代理

位于客户端应用程序和 API 服务器之间、中继请求和响应的服务器。 开发代理在你的机器上作为本地代理运行。

R

速率限制

一种技术 API,用于限制客户端在一段时间内可以发出的请求数。 开发代理可以通过返回 429(请求过多)响应来模拟速率限制。 与 限流进行比较。

记录

捕获 API 请求和响应的过程供以后分析。 开发代理可以记录流量并将其导出到各种格式。

记者

将记录的数据转换为可读格式(如 Markdown、JSON 或纯文本)的插件。 记者处理报告插件的输出。

报告插件

一个插件,用于分析记录的请求并生成有关 API 使用情况、权限或最佳做法的报告。

S

Schema

一个 JSON 架构文件,用于定义开发代理配置文件的结构和验证规则。 模式在支持它们的编辑器中启用 IntelliSense。

Shadow API

应用程序使用的、但尚未正式记录或组织已知的 API 终结点。 开发代理可帮助发现影子 API。

T

Throttling

当 API 由于负载过高或保护资源而有意减慢或拒绝请求时。 通常与 限流互换使用,但限流通常意味着一个临时状态,而速率限制是一项固定策略。

U

要监视的 URL

开发代理监视请求的 URL 模式。 仅截获匹配这些模式的请求。 模式支持通配符,例如 https://api.contoso.com/*

W

手表

监视对特定 URL 的请求。 Dev Proxy 监视您配置的 URL,并能截获符合条件的请求。

另请参阅