←All samples

Record your app's API calls in CI

This sample contains a preset to record which APIs your app calls, for example in a CI pipeline.

Waldek Mastykarz
Waldek Mastykarz

Record your app’s API calls in CI

Summary

This sample contains a preset to record which APIs your app calls, for example in a CI pipeline.

You want a list of the APIs that your app calls, but the default Dev Proxy config simulates random errors, and devproxy config new gives you an empty config. Picking the right plugins and reporters yourself takes time, and different people end up with different setups.

Using this preset, you start Dev Proxy in the background, start and stop recording through the Dev Proxy API around your app, and get a list of the URLs your app called and a summary of the requests. Dev Proxy doesn’t change the requests or responses, and doesn’t register itself as the system proxy.

Dev Proxy report listing the URLs that an app called

Compatibility

Dev Proxy v4.0.0

Contributors

Version history

Version Date Comments
1.0 November 5, 2026 Initial release

Minimal path to awesome

  • Get the sample:

    • Download just this sample:

      npx gitload-cli https://github.com/pnp/proxy-samples/tree/main/samples/api-inventory

      or

    • Download as a .ZIP file and unzip it, or

    • Clone this repository

    Alternatively, download the preset with Dev Proxy:

    devproxy config get api-inventory

    Dev Proxy saves the preset in ~dataFolder/configs/api-inventory. Run devproxy config get api-inventory --output json to get the full path.

  • Run your app through Dev Proxy with the record-api-calls.sh script. Pass the URLs that you want to record and the command that starts your app. Run the script from the folder where you want to save the reports:

    ./record-api-calls.sh "https://api.contoso.com/*" npm start
  • After your app exits, review the reports in the current folder.

The script requires devproxy, curl, and jq. The command that starts your app must exit on its own, for example, a test run or a script that calls the APIs and stops. If you downloaded the preset with devproxy config get, run the script with bash, for example, bash "<path>/record-api-calls.sh" "https://api.contoso.com/*" npm start.

Record API calls in CI

The record-api-calls.sh script runs the following steps. If you can’t use the script, for example on Windows, run the same steps in your CI pipeline. For more information, see Dev Proxy API.

  1. Start Dev Proxy in the background with the preset and the URLs to record. The --urls-to-watch option overrides the placeholder URL in the preset:

    DEVPROXY_INFO=$(devproxy --config-file .devproxy/devproxyrc.json \
      --urls-to-watch "https://api.contoso.com/*" \
      --detach --output json)
    PID=$(echo "$DEVPROXY_INFO" | jq -r '.data.pid')
    PROXY_URL=$(echo "$DEVPROXY_INFO" | jq -r '.data.proxyUrl')
    API_URL=$(echo "$DEVPROXY_INFO" | jq -r '.data.apiUrl')
  2. Get the token for the Dev Proxy API. Every call to the API requires it:

    AUTH_HEADER="Authorization: Bearer $(devproxy api token --pid "$PID")"
  3. Get the Dev Proxy root certificate, so that your app can trust it:

    curl -sf -H "$AUTH_HEADER" "$API_URL/proxy/rootCertificate?format=crt" -o devproxy-ca.pem
  4. Start recording:

    curl -sf -X POST -H "$AUTH_HEADER" -H "Content-Type: application/json" \
      -d '{"recording":true}' "$API_URL/proxy"
  5. Run your app through Dev Proxy. For example, for a Node.js 24 or later app:

    HTTPS_PROXY="$PROXY_URL" NODE_USE_ENV_PROXY=1 \
      NODE_EXTRA_CA_CERTS="$(pwd)/devproxy-ca.pem" npm start
  6. Stop recording. Dev Proxy writes the reports to the folder where you started it, before it responds:

    curl -sf -X POST -H "$AUTH_HEADER" -H "Content-Type: application/json" \
      -d '{"recording":false}' "$API_URL/proxy"
  7. Stop Dev Proxy:

    curl -sf -X POST -H "$AUTH_HEADER" "$API_URL/proxy/stopProxy"

To try the preset without a CI pipeline, start Dev Proxy by running devproxy --urls-to-watch "https://jsonplaceholder.typicode.com/*" --record in the sample’s folder, send a request, for example curl -ikx http://127.0.0.1:8000 https://jsonplaceholder.typicode.com/posts/1, and press s to stop recording.

Features

This preset records which APIs your app calls, without changing the requests or responses.

Using this sample you can use Dev Proxy to:

  • Get a list of the URLs that your app called, as JSON (UrlDiscoveryPlugin_JsonReporter.jsonc) and Markdown (UrlDiscoveryPlugin_MarkdownReporter.md). You can paste the JSON list into urlsToWatch in other Dev Proxy configs.
  • Get a summary of the recorded requests, grouped by URL, as JSON (ExecutionSummaryPlugin_JsonReporter.json) and Markdown (ExecutionSummaryPlugin_MarkdownReporter.md).
  • Optionally, save the recorded requests to a HAR file. To do this, set enabled to true for HarGeneratorPlugin in .devproxy/devproxyrc.json. By default, the HAR file doesn’t include response bodies, and Dev Proxy redacts sensitive information, such as authorization headers and cookies.

The preset sets asSystemProxy to false, so only apps that you configure to use Dev Proxy send requests through it. The preset uses https://api.contoso.com/* as a placeholder URL. Replace it in the config, or override it with the --urls-to-watch option.

For more information about the configuration options, see the documentation of the UrlDiscoveryPlugin, ExecutionSummaryPlugin, and HarGeneratorPlugin.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

If you encounter any issues using this sample, create a new issue.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.