Use preset configurations

At a glance
Goal: Use pre-built Dev Proxy configs
Time: 3 minutes
Plugins: Various
Prerequisites: Set up Dev Proxy

Using presets you can quickly configure Dev Proxy to work with common scenarios. A preset is a ready-made Dev Proxy config: a JSON file that defines which plugins Dev Proxy uses and how they're configured. Your own settings live in your config, for example devproxyrc.json.

Download a preset

The Dev Proxy samples gallery has presets for specific APIs, like GitHub, OpenAI, Anthropic, and Microsoft Graph. It also has samples: demo projects that show how to use Dev Proxy in a specific scenario.

To download a preset, use the config get command with the preset's ID, and then start Dev Proxy with the preset:

devproxy config get github-rate-limiting
devproxy --config-file "~dataFolder/configs/github-rate-limiting/.devproxy/devproxyrc.json"

Record your app's API calls

To record which APIs your app calls, for example in a CI/CD pipeline, use the api-inventory preset. It uses the UrlDiscoveryPlugin and ExecutionSummaryPlugin with reporters, and doesn't register Dev Proxy as the system proxy. Override its placeholder URLs with the APIs that your app calls:

devproxy config get api-inventory
devproxy --config-file "~dataFolder/configs/api-inventory/.devproxy/devproxyrc.json" --urls-to-watch "https://api.contoso.com/*"

For more information, see Use Dev Proxy in CI/CD scenarios and Record and export proxy activity.

Use a preset included with Dev Proxy

We include several presets with Dev Proxy. You can find them in the config folder in the Dev Proxy installation directory.

To use a preset, use the --config-file option and pass the path to the preset file:

devproxy --config-file config/microsoft-graph-rate-limiting.json

See also

  • Sist oppdatert