mockoon/cli repository overview

⁠

⁠Mockoon CLI's Docker image

Mockoon is the easiest and quickest way to run mock APIs locally. No remote deployment, no account required, free and open-source.

It's a desktop application and a CLI⁠ that help you work faster with APIs by mocking them. Integrate third-party APIs quicker, improve your integration tests, speed up your development, etc.

➡️ Download⁠

⁠Features

Mockoon offers many features:

• unlimited number of mock local servers and routes
• CLI to run your mock in headless environments, CI, etc.
• complete control on routes definition: HTTP methods and statuses, regex paths, file serving, custom headers, etc.
• OpenAPI compatibility
• Record/logs of all entering and forwarded requests
• JSON templating
• proxy forwarding mode
• HTTPS support

You can check the complete list⁠ on the website.

⁠Mockoon CLI

Mockoon CLI is a lightweight and fast NPM package⁠ to deploy your Mockoon's mock APIs anywhere. Please look at our dedicated documentation⁠ to learn how to install and use it.

⁠Mockoon CLI's Docker image quick start

A generic Docker image is published on the Docker Hub Mockoon CLI repository⁠. It uses node:18-alpine and installs the latest version of Mockoon CLI.

All of mockoon-cli start flags (--port, etc.) must be provided when running the container.

To load the Mockoon data, you can either mount a local data file and pass mockoon-cli start flags at the end of the command:

docker run -d --mount type=bind,source=/home/your-data-file.json,target=/home/mockoon/data/your-data-file.json,readonly -p 3000:3000 mockoon/cli:latest --data /home/mockoon/data/your-data-file.json --port 3000

Or directly pass a URL to the mockoon-cli start command, without mounting a local data file:

docker run -d -p 3000:3000 mockoon/cli:latest -d https://raw.githubusercontent.com/mockoon/mock-samples/main/samples/generate-mock-data.json --port 3000

➡️Full documentation⁠