MAST - Mock API Server for Testing

A configurable API server for mocking.

MAST was created to facilitate rapid mocking of APIs. This supports:

• unit/integration testing of external APIs
• frontend development against yet-to-be-developed services

Get the image at Docker Hub.

Develop an API

Create an api.raml file compliant with the RAML API spec.

Pull the MAST container.

docker pull quantworks/mast

Run the container with your api.raml mounted to /srv/api/api.raml. This allows you to edit/save your api.raml and the server will hot-reload the API.

docker run -it --rm \
    -p 80:80 \
    -p 443:443 \
    -v $(pwd)/api.raml:/srv/api/api.raml \
    quantworks/mast:latest
# or with custom ports
docker run -it --rm \
    -e HTTP=8080 \
    -e HTTPS=8443 \
    -p 80:8080 \
    -p 443:8443 \
    -v $(pwd)/api.raml:/srv/api/api.raml \
    quantworks/mast:latest

Test it!

curl -s http://0.0.0.0/endpoint | jq .
curl -sk https://0.0.0.0/endpoint | jq .

Create a new mock service

Create a Dockerfile.

FROM quantworks/mast:latest

Write an api.raml file. Then build and run your container.

docker build -t my-api:latest .
docker run -it --rm \
    -p 80:80 \
    -p 443:443 \
    my-api:latest
# or with custom ports
docker run -it --rm \
    -e HTTP=8080 \
    -e HTTPS=8443 \
    -p 80:8080 \
    -p 443:8443 \
    -v $(pwd)/api.raml:/srv/api/api.raml \
    quantworks/mast:latest

Test it!

curl -s http://0.0.0.0/endpoint | jq .
curl -sk https://0.0.0.0/endpoint | jq .

License

MIT