| title | description | author | ms.author | ms.date | ms.topic |
|---|---|---|---|---|---|
Technical reference |
Technical reference |
garrytrinder |
garrytrinder |
04/15/2025 |
overview |
This section contains technical reference for Dev Proxy plugins and configuration options.
List of plugins that work with any API.
| Name | Description |
|---|---|
| AuthPlugin | Simulates authentication and authorization using API keys or OAuth2. |
| DevToolsPlugin | Exposes Dev Proxy messages, and information about intercepted requests and responses in Chrome DevTools. |
| CachingGuidancePlugin | Shows a warning when Dev Proxy intercepted the same request within the specified period of time. |
| CrudApiPlugin | Simulates a CRUD API with an in-memory data store. |
| ExecutionSummaryPlugin | Generates a summary report of the requests that pass through the proxy. |
| GenericRandomErrorPlugin | Fails requests with a random selected error from file containing mocked errors. |
| HttpFileGeneratorPlugin | Generates HTTP file from the intercepted requests and responses. |
| LatencyPlugin | Delays responses by a random number of milliseconds from the configured range. |
| MinimalCsomPermissionsPlugin | Detects the minimal permissions needed to call the recorded SharePoint Client-Side Object Model (CSOM) API requests. |
| MinimalPermissionsPlugin | Checks if the app uses minimal permissions to call APIs. Uses API information from the specified local folder. |
| MinimalPermissionsGuidancePlugin | Compares the permissions used in the JWT token sent to APIs against the minimum required scopes needed for requests that proxy recorded and shows the difference. |
| MockGeneratorPlugin | Generates Dev Proxy mocks based on the intercepted requests. |
| MockRequestPlugin | Allows you to issue web requests using Dev Proxy. |
| MockResponsePlugin | Simulates responses. |
| ODataPagingGuidancePlugin | Shows a warning when proxy intercepts an OData paging request using a URL that hasn't been previously returned in one of the intercepted responses. |
| OpenAIMockResponsePlugin | Simulates responses from Azure OpenAI and OpenAI using a local language model. |
| OpenApiSpecGeneratorPlugin | Generates OpenAPI spec from the intercepted requests and responses. |
| RateLimitingPlugin | Simulates rate-limit behaviors. |
| RetryAfterPlugin | Simulates the Retry-After header sent by an API after throttling a request. |
| RewritePlugin | Rewrites requests. |
| TypeSpecGeneratorPlugin | Generates TypeSpec files from the intercepted requests and responses. |
| UrlDiscoveryPlugin | Creates a list of URLs that the proxy has intercepted. |
List of plugins that work with Azure API Center.
| Name | Description |
|---|---|
| ApiCenterMinimalPermissionsPlugin | Checks if the app uses minimal permissions to call APIs. Uses API information from the specified Azure API Center instance. |
| ApiCenterOnboardingPlugin | Checks if the APIs used in an app are registered in the specified Azure API Center instance. |
| ApiCenterProductionVersionPlugin | Checks if the APIs used in an app are production version of the APIs registered in the specified Azure API Center instance. |
List of plugins that work with Microsoft Entra API.
| Name | Description |
|---|---|
| EntraMockResponsePlugin | Mocks responses to Microsoft Entra. |
List of plugins that work with Microsoft Graph API.
| Name | Description |
|---|---|
| GraphBetaSupportGuidancePlugin | Shows a warning when proxy detects a request to Microsoft Graph beta endpoint. |
| GraphClientRequestIdGuidancePlugin | Shows a tip when a request to Microsoft Graph API doesn't include the client-request-id header. |
| GraphConnectorGuidancePlugin | Shows contextual guidance for working with Microsoft Graph connectors. |
| GraphConnectorNotificationPlugin | Simulates the notification when enabling or disabling a Microsoft Graph connector in Teams Admin Center (TAC). Validates requests for creating and deleting the external connection. |
| GraphMinimalPermissionsPlugin | Returns a list of the minimal permissions required for Microsoft Graph requests that proxy recorded. |
| GraphMinimalPermissionsGuidancePlugin | Compares the permissions used in the JWT token sent to Microsoft Graph against the minimum required scopes needed for requests that proxy recorded and shows the difference. |
| GraphMockResponsePlugin | Mocks responses to Microsoft Graph APIs. |
| GraphRandomErrorPlugin | Fails requests made to Microsoft Graph with random errors. |
| GraphSdkGuidancePlugin | Shows a tip when proxy intercepts a request to Microsoft Graph that hasn't been issued by a Microsoft Graph SDK. |
| GraphSelectGuidancePlugin | Shows a warning when proxy intercepts a request to Microsoft Graph APIs that doesn't include the $select query string parameter. |
| ODSPSearchGuidancePlugin | Shows a warning when Dev Proxy detects a request to OneDrive and SharePoint search APIs. |
List of reporters that generate reports in different formats.
| Name | Description |
|---|---|
| JsonReporter | Generates reports in JSON format. |
| MarkdownReporter | Generates reports in Markdown format. |
| PlainTextReporter | Generates reports in plain-text format. |
Reference of Dev Proxy configuration options.
| Name | Description |
|---|---|
| devproxyrc | Configuration file for Dev Proxy. |
| Proxy API | API for interacting with Dev Proxy programmatically. |
| Proxy settings | Configuration options for proxy settings. |