Minimal PowerShell script using Dev Proxy

Summary

This sample demonstrates the minimal setup to use Dev Proxy with a PowerShell script. It shows how to:

• Configure Dev Proxy to intercept API requests
• Mock API responses using the MockResponsePlugin
• Run a PowerShell script through Dev Proxy using Invoke-RestMethod

The sample makes a single API call to JSONPlaceholder and returns a mocked response, demonstrating how Dev Proxy intercepts and replaces the real API call.

Compatibility

Contributors

• Waldek Mastykarz

Version history

Prerequisites

• Dev Proxy
• PowerShell 7.x

Minimal path to awesome

• Get the sample:

  • Download just this sample:

    npx gitload-cli https://github.com/pnp/proxy-samples/tree/main/samples/minimal-powershell

    or

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

  • Clone this repository

• Navigate to the sample folder: cd samples/minimal-powershell
• In one terminal, start Dev Proxy: devproxy
• In another terminal, run the script: pwsh app.ps1
• Observe the mocked API response in the console with headers x-powered-by: Dev Proxy and x-mocked-by: Dev Proxy MockResponsePlugin

Features

This sample illustrates the following concepts:

• Configuring Dev Proxy with a .devproxy/devproxyrc.json file
• Using MockResponsePlugin to return custom API responses
• Running PowerShell scripts through Dev Proxy using -Proxy parameter
• Using -SkipCertificateCheck to bypass SSL validation for Dev Proxy
• Adding custom headers to mocked responses

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.