Microsoft Graph Developer Proxy
Microsoft Graph Developer Proxy

Build with Microsoft Graph. Reliably

Get started | Example usage | Features | Trademarks | Community Preview

msgraph-developer-proxy-short.mp4

Microsoft Graph Developer Proxy is a command line tool that simulates real world behaviours of Microsoft Graph, locally.

Microsoft Graph Developer Proxy aims to provide a better way to test applications that use Microsoft Graph. Using the proxy to simulate errors, mock responses and demonstrate behaviours like throttling, developers can identify and fix issues in their code early in the development cycle before they reach production.

Get started

If you are new to Microsoft Graph Developer Proxy, we highly recommend that you begin with our tutorial which will guide you through the installation process and running the proxy for the first time.

Example usage

Start the proxy on port 8080, set the chance for a request to Microsoft Graph to fail with an HTTP status code of either 429 or 503 at 50%, and ignore any mock responses that may have been provided, execute:

msgraph-developer-proxy --port 8080 --failure-rate 50 --no-mocks --allowed-errors 429 503

Features

  • run on any OS
    • Windows
    • macOS
    • Linux
  • simulate different Microsoft Graph API errors
  • verify that your application properly handles throttling
  • mock Microsoft Graph API responses
  • define wildcard paths to serve mocked responses
  • mock responses of different types (JSON, binary, etc.)
  • configure proxy to your needs, by setting:
    • failure rate
    • port
    • whether to use mock responses or not
    • which Microsoft Cloud to use (public, DoD, etc.)

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. 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.

Community Preview

We are working on getting the General Availability (GA) version published within the calendar year 2023. The current state of the Microsoft Graph Developer Proxy enables our team to be transparent and provide more insights on the upcoming features and to provide our worldwide ecosystem an option to directly influence the future of our capabilities. Your feedback is more than welcome! You can expect many more new features within the upcoming months before a version that is officially ready for production use and fully supported.

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