开发代理的技术参考

本部分包含开发代理插件和配置选项的技术参考。

插件

适用于任何 API 的插件列表。

名称 描述
AuthPlugin 使用 API 密钥或 OAuth2 模拟身份验证和授权。
DevToolsPlugin 公开开发代理消息,以及有关 Chrome DevTools 中截获的请求和响应的信息。
CachingGuidancePlugin 显示开发代理在指定时间段内截获同一请求时出现警告。
CrudApiPlugin 使用内存中数据存储模拟 CRUD API。
ExecutionSummaryPlugin 生成通过代理的请求的摘要报告。
GenericRandomErrorPlugin 失败请求,其中包含模拟错误的文件中随机选择的错误。
HttpFileGeneratorPlugin 从截获的请求和响应生成 HTTP 文件。
LatencyPlugin 延迟从配置的范围内的随机数毫秒的响应。
MinimalPermissionsPlugin 检查应用是否使用最少的权限来调用 API。 使用指定本地文件夹中的 API 信息。
MockGeneratorPlugin 根据截获的请求生成开发代理模拟。
MockRequestPlugin 允许使用开发代理发出 Web 请求。
MockResponsePlugin 模拟响应。
ODataPagingGuidancePlugin 当代理使用以前未在某个截获的响应中返回的 URL 截获 OData 分页请求时显示警告。
OpenAIMockResponsePlugin 使用本地语言模型模拟来自 Azure OpenAI 和 OpenAI 的响应。
OpenApiSpecGeneratorPlugin 从截获的请求和响应生成 JSON 格式的 OpenAPI 规范。
RateLimitingPlugin 模拟速率限制行为。
RetryAfterPlugin Retry-After模拟 API 在限制请求后发送的标头。

Azure API 中心插件

适用于 Azure API 中心的插件列表。

名称 描述
ApiCenterMinimalPermissionsPlugin 检查应用是否使用最少的权限来调用 API。 使用来自指定 Azure API 中心实例的 API 信息。
ApiCenterOnboardingPlugin 检查应用中使用的 API 是否已在指定的 Azure API 中心实例中注册。
ApiCenterProductionVersionPlugin 检查应用中使用的 API 是否为在指定的 Azure API 中心实例中注册的 API 的生产版本。

Microsoft Entra 插件

适用于 Microsoft Entra API 的插件列表。

名称 描述
EntraMockResponsePlugin 模拟对 Microsoft Entra 的响应。

Microsoft Graph 插件

使用 Microsoft 图形 API 的插件列表。

名称 描述
GraphBetaSupportGuidancePlugin 当代理检测到Microsoft Graph beta 终结点的请求时显示警告。
GraphClientRequestIdGuidancePlugin 当请求Microsoft图形 API 不包含 client-request-id 标头时显示提示。
GraphConnectorGuidancePlugin 显示有关使用 Microsoft Graph 连接器的上下文指南。
GraphConnectorNotificationPlugin 在 Teams 管理中心 (TAC) 中启用或禁用 Microsoft Graph 连接器时模拟通知。 验证创建和删除外部连接的请求。
GraphMinimalPermissionsPlugin 返回代理记录的 Microsoft Graph 请求所需的最小权限的列表。
GraphMinimalPermissionsGuidancePlugin 将发送到 Microsoft Graph 的 JWT 令牌中使用的权限与代理记录的请求所需的最低范围进行比较,并显示差异。
GraphMockResponsePlugin 模拟对Microsoft图形 API 的响应。
GraphRandomErrorPlugin 失败向 Microsoft Graph 发出的请求,并出现随机错误。
GraphSdkGuidancePlugin 当代理截获Microsoft Graph 的请求时显示提示,该请求尚未由 Microsoft Graph SDK 发出。
GraphSelectGuidancePlugin 当代理截获Microsoft不包含 $select 查询字符串参数的图形 API 的请求时,会显示警告。
ODSPSearchGuidancePlugin 当开发代理检测到对 OneDrive 和 SharePoint 搜索 API 的请求时显示警告。

记者

以不同格式生成报表的记者列表。

名称 描述
JsonReporter 以 JSON 格式生成报表。
MarkdownReporter 以 Markdown 格式生成报表。
PlainTextReporter 以纯文本格式生成报表。

配置

开发代理配置选项的参考。

名称 描述
devproxyrc 开发代理的配置文件。
代理 API 用于以编程方式与开发代理交互的 API。
代理设置 代理设置的配置选项。