https://github.com/commercetools/vrap
Validating REST API proxy
https://github.com/commercetools/vrap
audit-sdk groovy java proxy raml raml-test raml-tooling rest
Last synced: about 1 month ago
JSON representation
Validating REST API proxy
- Host: GitHub
- URL: https://github.com/commercetools/vrap
- Owner: commercetools
- License: mit
- Created: 2017-03-15T17:30:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T21:38:54.000Z (over 2 years ago)
- Last Synced: 2025-04-20T15:18:00.264Z (about 1 month ago)
- Topics: audit-sdk, groovy, java, proxy, raml, raml-test, raml-tooling, rest
- Language: Java
- Homepage: http://www.vrap.io
- Size: 23.4 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/vrapio/vrap)
# VRAP
Vrap is a validating REST API proxy. In order to be able to validate rest api calls the proxy consumes [RAML](http://raml.org/) 1.0 definition files
## Usage
### Docker
To start vrap using docker use the following command
```
docker run -v:/api -p5050:5050 vrapio/vrap /api/api.raml
```
## Running vrap locally
### Run from shadow/fat jar
Build shadow jar with gradle:
```
./gradlew shadowJar
```
Then run built shadow with java:
```
java -jar build/libs/vrap-all.jar
```
### Directly via gradle
```
./gradlew run -PcliArgs=
```
## Validation
In order to validate incoming requests and responses your application has to be configured to use the vrap api url: [http://localhost:5050/api]()
## Web Interface
Vrap includes a small web interface for browsing the API definition.
- API browser [http://localhost:5050/api-raml/]()
- with resolved includes [http://localhost:5050/api-raml/?include]()