@pb33f/wiretap 0.0.10 → 0.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# wiretap
|
|
2
2
|
|
|
3
3
|
A local and pipeline based tool to sniff API request and responses from clients and servers
|
|
4
|
-
to detect OpenAPI contract violations and compliance.
|
|
4
|
+
to detect OpenAPI contract violations and compliance.
|
|
5
5
|
|
|
6
6
|
A shift left tool, for those who want to know if their applications
|
|
7
7
|
are actually compliant with an API.
|
|
@@ -9,4 +9,17 @@ are actually compliant with an API.
|
|
|
9
9
|
This is an early tool and in active development.
|
|
10
10
|
|
|
11
11
|
Probably best to leave this one alone for now, come back later
|
|
12
|
-
when it's a little more baked.
|
|
12
|
+
when it's a little more baked.
|
|
13
|
+
|
|
14
|
+
## Command Line Interface
|
|
15
|
+
|
|
16
|
+
### Available Flags
|
|
17
|
+
|
|
18
|
+
| Shortcut | Flag | Description |
|
|
19
|
+
| -------- | ---------------- | ------------------------------------------------------------------------------------------ |
|
|
20
|
+
| `-u` | `--url` | Redirect URL for wiretap to send traffic to. |
|
|
21
|
+
| `-s` | `--spec` | Path to the OpenAPI Specification to use. |
|
|
22
|
+
| `-p` | `--port` | Port on which to listen for API traffic. (default is `9090`) |
|
|
23
|
+
| `-m` | `--monitor-port` | Port on which to serve the monitor UI. (default is `9091`) |
|
|
24
|
+
| `-d` | `--delay` | Set a global delay for all API requests in milliseconds. (default is `0`) |
|
|
25
|
+
| `-c` | `--config` | Location of wiretap configuration file to use (default is `.wiretap` in current directory) |
|
package/package.json
CHANGED