Skip to content

Commit ad4c25c

Browse files
committed
Update README with validation server usage
1 parent 776ab26 commit ad4c25c

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,21 @@ If multiple projects are scanned at once, the JSON output will contain a single
8484
-output=...
8585
Specifies an output file that endpoints will be written to when using JSON serialization. This requires either `-json` or `-simple-json` to also be set, otherwise this flag has no effect.
8686

87+
88+
***
89+
90+
-validation-server=http://localhost:1234/abc...
91+
Specifies a base URL path that will be used and queried against to test all detected endpoints. Endpoints that return `404` will be marked as "failed" and listed in the terminal.
92+
93+
***
94+
95+
- validation-server-auth=<login-endpoint>;usename=foo;password=bar;...
96+
Specifies how to authenticate against the server provided with `-validation-server`. Arguments are separated by semicolons `;`. The first argument will be the endpoint to use for authentication. Subsequent arguments will be sent to the endpoint while authenticating.
97+
98+
The specified endpoint will be POSTed to, and the provided query parameters will be encoded as Form parameters. Result of authentication will be output in the console.
99+
100+
Any cookies found in the response will be attached to all subsequent requests during testing.
101+
87102
## Build Instructions
88103
The module can be built with maven:
89104

0 commit comments

Comments
 (0)