Skip to content

Commit 6cefccb

Browse files
committed
Add features to readme
1 parent f661b4a commit 6cefccb

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,57 @@
11
# Dev Proxy for Visual Studio Code
22

3+
[Dev Proxy](https://aka.ms/devproxy) is a command line tool that helps you simulate behaviors and errors of cloud APIs.
4+
35
The Dev Proxy extension makes it easy to create and update configuration files.
6+
7+
## Features
8+
9+
### Snippets
10+
11+
| Prefix | Description |
12+
| ------ | ----------- |
13+
| `devproxy-config` | Dev Proxy config file |
14+
| `devproxy-errors` | Dev Proxy errors file |
15+
| `devproxy-plugin-caching-guidance` | CachingGuidancePlugin instance |
16+
| `devproxy-plugin-caching-guidance-config` | CachingGuidancePlugin config section |
17+
| `devproxy-plugin-crud-api` | CrudApiPlugin instance |
18+
| `devproxy-plugin-crud-api-config` | CrudApiPlugin config section |
19+
| `devproxy-plugin-dev-tools` | DevToolsPlugin instance |
20+
| `devproxy-plugin-dev-tools-config` | DevToolsPlugin config section |
21+
| `devproxy-plugin-execution-summary` | ExecutionSummaryPlugin instance |
22+
| `devproxy-plugin-execution-summary-config` | ExecutionSummaryPlugin config section |
23+
| `devproxy-plugin-generic-random-error` | GenericRandomErrorPlugin instance |
24+
| `devproxy-plugin-generic-random-error-config` | GenericRandomErrorPlugin config section |
25+
| `devproxy-plugin-graph-beta-support-guidance` | GraphBetaSupportGuidancePlugin instance |
26+
| `devproxy-plugin-graph-client-request-id-guidance` | GraphClientRequestIdGuidancePlugin instance |
27+
| `devproxy-plugin-graph-mock-response` | GraphMockResponsePlugin instance |
28+
| `devproxy-plugin-graph-random-error` | GraphRandomErrorPlugin instance |
29+
| `devproxy-plugin-graph-random-error-config` | GraphRandomErrorPlugin config section |
30+
| `devproxy-plugin-graph-sdk-guidance` | GraphSdkGuidancePlugin instance |
31+
| `devproxy-plugin-graph-select-guidance` | GraphSdkGuidancePlugin instance |
32+
| `devproxy-plugin-latency` | LatencyPlugin instance |
33+
| `devproxy-plugin-latency-config` | LatencyPlugin config section |
34+
| `devproxy-plugin-graph-minimal-permissions-guidance` | MinimalPermissionsGuidancePlugin instance |
35+
| `devproxy-plugin-graph-minimal-permissions-guidance-config` | MinimalPermissionsGuidancePlugin config section |
36+
| `devproxy-plugin-graph-minimal-permissions` | MinimalPermissionsPlugin instance |
37+
| `devproxy-plugin-graph-minimal-permissions-config` | MinimalPermissionsPlugin config section |
38+
| `devproxy-plugin-mock-generator` | MockGeneratorPlugin instance |
39+
| `devproxy-plugin-mock-response` | MockResponsePlugin instance |
40+
| `devproxy-plugin-mock-response-config` | MockResponsePlugin config section |
41+
| `devproxy-plugin-odata-paging-guidance` | ODataPagingGuidancePlugin instance |
42+
| `devproxy-plugin-graph-odsp-search-guidance` | ODSPSearchGuidancePlugin instance |
43+
| `devproxy-plugin-open-api-doc-generator` | OpenApiDocGeneratorPlugin instance |
44+
| `devproxy-plugin-open-api-doc-generator` | OpenAPIDocGeneratorPlugin instance |
45+
| `devproxy-plugin-rate-limiting` | MockResponsePlugin instance |
46+
| `devproxy-plugin-rate-limiting-config` | RateLimitingPlugin config section |
47+
| `devproxy-plugin-retry-after` | RetryAfterPlugin instance |
48+
| `devproxy-response` | Empty Dev Proxy response |
49+
| `devproxy-response-header` | Empty Dev Proxy response header |
50+
51+
### Diagnostics
52+
53+
The following diagnostic checks are performed:
54+
55+
- Check for empty `urlsToWatch`.
56+
- Check for missing `configSection` property in plugin instance for plugins that require configuration.
57+
- Check for missing `configSection` when defined in plugin instance

0 commit comments

Comments
 (0)