Dev Proxy 的技术参考

本部分包含 Dev Proxy 插件和配置选项的技术参考。

插件

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

名称 描述
AuthPlugin 使用 API 密钥或 OAuth2 模拟身份验证和授权。
DevToolsPlugin 在 Chrome DevTools 中公开开发代理消息,以及有关拦截的请求和响应的信息。
CachingGuidancePlugin 当开发代理在指定时间段内截获相同请求时,会显示警告。
CrudApiPlugin 使用内存中数据存储模拟 CRUD API。
ExecutionSummaryPlugin 生成通过代理的请求的摘要报告。
GenericRandomErrorPlugin 通过从包含模拟错误的文件中随机选择的一个错误,使请求失败。
HttpFileGeneratorPlugin 从截获的请求和响应生成 HTTP 文件。
LatencyPlugin 响应的延迟时间为从配置范围内随机选择的毫秒数。
MinimalCsomPermissionsPlugin 检测调用记录的 SharePoint Client-Side 对象模型 (CSOM) API 请求所需的最小权限。
MinimalPermissionsPlugin 检查应用是否使用最少的权限来调用 API。 使用指定本地文件夹中的 API 信息。
MinimalPermissionsGuidancePlugin 将发送到 API 的 JWT 令牌中使用的权限与代理记录的请求所需的最小必需范围进行比较,并显示差异。
MockGeneratorPlugin 根据截获的请求生成开发代理模拟。
MockRequestPlugin 允许你使用开发代理发出 Web 请求。
MockResponsePlugin 模拟响应。
ODataPagingGuidancePlugin 当代理使用以前未在某个截获的响应中返回的 URL 截获一个 OData 分页请求时,显示一个警告。
OpenAIMockResponsePlugin 使用本地语言模型模拟来自 Azure OpenAI 和 OpenAI 的响应。
OpenAITelemetryPlugin 为 OpenAI 兼容的 API 请求生成遥测数据。
OpenApiSpecGeneratorPlugin 从截获的请求和响应生成 OpenAPI 规范。
RateLimitingPlugin 模拟速率限制行为。
RetryAfterPlugin 模拟限制请求后 API 发送的 Retry-After 标头。
RewritePlugin 重写请求。
TypeSpecGeneratorPlugin 从截获的请求和响应生成 TypeSpec 文件。
UrlDiscoveryPlugin 创建代理截获的 URL 列表。

Azure API 中心插件

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

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

Microsoft Entra 插件

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

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

Microsoft Graph 插件

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

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

记者

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

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

配置

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

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