Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nidi3/raml-tester-proxy
Test if requests/responses are raml compliant as a standalone proxy
https://github.com/nidi3/raml-tester-proxy
javascript proxy raml testing
Last synced: 13 days ago
JSON representation
Test if requests/responses are raml compliant as a standalone proxy
- Host: GitHub
- URL: https://github.com/nidi3/raml-tester-proxy
- Owner: nidi3
- License: apache-2.0
- Created: 2014-05-20T15:16:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-02T13:35:05.000Z (over 7 years ago)
- Last Synced: 2024-10-30T03:37:47.329Z (2 months ago)
- Topics: javascript, proxy, raml, testing
- Language: Java
- Size: 309 KB
- Stars: 13
- Watchers: 5
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
raml-tester-proxy [](https://travis-ci.org/nidi3/raml-tester-proxy)
=================
A standalone proxy/mock that tests if requests/responses are compliant with a given RAML.
To see all options, execute
```
java -jar raml-tester-standalone.jar
```
##Usage as proxy
Example: If there is a service running at localhost:8080, start the proxy with
```
java -jar raml-tester-standalone.jar -t localhost:8080 -r -s.
```
and access the service using localhost:8099.
Every request or response that does not match the RAML definition will be logged.
##Run asynchronously
If the proxy is started with the -a flag, it runs asynchronously.
You can send commands to it the following way:
```
java -jar raml-tester-standalone.jar
```
These commands are supported:
- ping: Ping the proxy
- stop: Stop the proxy
- reload: Reload the RAML file
- validate: Validate the RAML file
- reports: Get the reports of the RAML violations
- usage: Get information about usage of RAML elements
See also [the RAML definition](raml-tester-client/src/main/resources/proxy.raml).
##Usage as Mock
Instead of forwarding all requests to another server, the tool can also be used to return mock responses.
(Which will also be verified against a RAML file.)
Use the -m option instead of -t to run in mock mode:
```
java -jar raml-tester-standalone.jar -m mock-data -r -s.
```
The files in directory `mock-data` will be used as responses.
- A request to `localhost:8099/admin/user/` will be responded with any of the files `mock-data/admin/user.{json|xml|txt}`,
if one exists.
- Responses can be specialized by prepending the HTTP method:
A GET request will first search for `mock-data/admin/GET-user.json` and then for the general `mock-data/admin/user.json`.
- If a file named `mock-data/admin/META-user.json` exists, it is used to define response code and reponse headers.
An example file looks like `{ "code": 202, "headers": {"X-meta": "get!"} }`.
- If no matching file for a request is found, `RESPONSE.json` is searched up the directory structure and used if found.
`mock-data/RESPONSE.json` would be used whenever no exact matching file is found. The same is true for `META-` files.
##Usage from Javascript
There is a special support for usage from javascript.
See [raml-tester-js](raml-tester-js/README.md) for details and
[raml-tester-uc-js](https://github.com/nidi3/raml-tester-uc-js) for examples.