https://github.com/microsoft/dev-proxy

Dev Proxy is an API simulator that helps you effortlessly test your app beyond the happy path.
https://github.com/microsoft/dev-proxy

command-line-tool dev-proxy developer-tools development devxeng hacktoberfest http microsoft-365 microsoft-graph proxy rest

Last synced: 3 months ago
JSON representation

Dev Proxy is an API simulator that helps you effortlessly test your app beyond the happy path.

• Host: GitHub
• URL: https://github.com/microsoft/dev-proxy
• Owner: microsoft
• License: mit
• Created: 2022-09-09T18:11:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T11:22:00.000Z (8 months ago)
• Last Synced: 2024-05-22T13:46:33.105Z (8 months ago)
• Topics: command-line-tool, dev-proxy, developer-tools, development, devxeng, hacktoberfest, http, microsoft-365, microsoft-graph, proxy, rest
• Language: C#
• Homepage: https://aka.ms/devproxy
• Size: 5.37 MB
• Stars: 412
• Watchers: 15
• Forks: 48
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


    

  
Dev Proxy






  Test the untestable



 



    

        

    





    

        

    





  Get started |

  Documentation





  Example |

  Features |

  Trademarks





    

  

    

    

    📽️ Simulate throttling using Dev Proxy

    

  

  

  



Dev Proxy is a command line tool for simulating APIs for testing apps.

It aims to provide a better way to test applications.

Use the proxy to:

- simulate errors

- simulate API behaviours

- mock responses

Identify and fix issues in your code before they reach production.

## Get started

Begin with our [tutorial](https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/get-started/). It will guide you through the installation process and running the proxy for the first time.

## Example

Fail requests (with a 50% chance) and respond with `429 Too Many Requests` or `503 Service Unavailable`:

```

devproxy --failure-rate 50 --no-mocks --allowed-errors 429 503

```

## Features

- run on any OS

  - Windows

  - macOS

  - Linux

- intercept requests from Microsoft Graph and other APIs

- simulate errors

- simulate throttling

- simulate rate-limiting

- mock responses

- mock error responses

- define wildcard paths to serve mocked responses

- mock responses of different types (JSON, binary, etc.)

- `$select` guidance to improve performance

- caching guidance to improve performance

- OData paging guidance

- client-request-id header guidance

- non-production beta endpoint guidance for Microsoft Graph

- configure proxy to your needs, by setting:

  - failure rate

  - port

  - whether to use mock responses or not

  - URLs to intercept traffic

- record proxy activity

- get proxy activity summary report

- detect minimal Microsoft Graph API permissions

- check for excessive Microsoft Graph API permissions

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

## A Microsoft Hackathon 2022 Project

The initial build of this project was completed in the week of 5-9 September 2022 by Waldek Mastykarz, Gavin Barron and Garry Trinder