Skip to content

Commit 23c2ae9

Browse files
authored
Update README.md (#216)
1 parent 643588b commit 23c2ae9

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</p>
2020

2121
<p align="center">
22-
<a href="#example-usage">Example usage</a> |
22+
<a href="#example">Example</a> |
2323
<a href="#features">Features</a> |
2424
<a href="#trademarks">Trademarks</a> |
2525
<a href="#community-preview">Community Preview</a>
@@ -30,20 +30,28 @@
3030
</video>
3131
</p>
3232

33-
Microsoft Graph Developer Proxy is a command line tool that simulates real world behaviours of Microsoft Graph and other APIs, locally.
33+
Microsoft Graph Developer Proxy is a command line tool for testing Microsoft Graph and other APIs.
3434

35-
Microsoft Graph Developer Proxy aims to provide a better way to test applications that use Microsoft Graph and other APIs. 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.
35+
It aims to provide a better way to test applications.
36+
37+
Use the proxy to:
38+
39+
- simulate errors
40+
- simulate throttling
41+
- mock responses
42+
43+
Identify and fix issues in your code before they reach production.
3644

3745
## Get started
3846

39-
If you are new to Microsoft Graph Developer Proxy, we highly recommend that you begin with our [tutorial](https://github.com/microsoftgraph/msgraph-developer-proxy/wiki/Get-started) which will guide you through the installation process and running the proxy for the first time.
47+
Begin with our [tutorial](https://github.com/microsoftgraph/msgraph-developer-proxy/wiki/Get-started). It will guide you through the installation process and running the proxy for the first time.
4048

41-
## Example usage
49+
## Example
4250

43-
Start the proxy on port 8080, set the chance for a request 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:
51+
Fail requests (with a 50% chance) and respond with `429 Too Many Requests` or `503 Service Unavailable`:
4452

4553
```
46-
msgraph-developer-proxy --port 8080 --failure-rate 50 --no-mocks --allowed-errors 429 503
54+
mgdp --failure-rate 50 --no-mocks --allowed-errors 429 503
4755
```
4856

4957
## Features
@@ -56,6 +64,7 @@ msgraph-developer-proxy --port 8080 --failure-rate 50 --no-mocks --allowed-error
5664
- simulate errors
5765
- simulate throttling
5866
- mock responses
67+
- mock error responses
5968
- define wildcard paths to serve mocked responses
6069
- mock responses of different types (JSON, binary, etc.)
6170
- `$select` guidance to improve performance
@@ -65,6 +74,8 @@ msgraph-developer-proxy --port 8080 --failure-rate 50 --no-mocks --allowed-error
6574
- port
6675
- whether to use mock responses or not
6776
- URLs to intercept traffic
77+
- record proxy activity
78+
- get proxy activity summary report
6879

6980
## Trademarks
7081

0 commit comments

Comments
 (0)