Technical reference for Dev Proxy
This section contains technical reference for Dev Proxy plugins and configuration options.
Plugins
List of plugins that work with any API.
Name | Description |
---|---|
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. |
LatencyPlugin | Delays responses by a random number of milliseconds from the configured range. |
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. |
OpenApiSpecGeneratorPlugin | Generates OpenAPI spec in JSON format 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. |
Azure API Center plugins
List of plugins that work with Azure API Center.
Name | Description |
---|---|
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. |
Microsoft Entra plugins
List of plugins that work with Microsoft Entra API.
Name | Description |
---|---|
EntraMockResponsePlugin | Mocks responses to Microsoft Entra. |
Microsoft Graph plugins
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. |
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. |
MinimalPermissionsPlugin | Returns a list of the minimal permissions required for Microsoft Graph requests that proxy recorded. |
MinimalPermissionsGuidancePlugin | 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. |
ODSPSearchGuidancePlugin | Shows a warning when Dev Proxy detects a request to OneDrive and SharePoint search APIs. |
Configuration
Reference of Dev Proxy configuration options.
Name | Description |
---|---|
devproxyrc | Configuration file for Dev Proxy. |
Proxy settings | Configuration options for proxy settings. |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for