mockoon / mockoon.com

Mockoon application official website repository and documentation

Mockoon: awesome API mocking

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.

---

Our sponsors

Platinum

       

Silver

Mockoon is an open-source project built by volunteer maintainers. If you like our application, please consider sponsoring us and join all the Sponsors and Backers who helped this project over time!

---

Download the desktop application

You can get Mockoon desktop's latest release directly from this repository or on the official website. Mockoon desktop is also available through:

MacOS:

• Homebrew: brew install --cask mockoon.

Windows:

• winget: winget install mockoon.
• Chocolatey: choco install mockoon.
• Windows Store

Linux:

• Snap store: snap install mockoon.
• AUR: yay -S mockoon-bin.

Install the CLI

Mockoon CLI is available as an NPM package. Please check our dedicated documentation to learn how to install and use it.

Use in cloud functions and serverless environments

Mockoon's Serverless NPM package provides an easy way to run Mockoon's mock APIs in cloud functions and serverless environments: AWS Lambda, GCP Functions, Firebase Functions, etc.

Please check our dedicated documentation to learn how to use it.

Subscribe to Mockoon Pro

With advanced features for solo developers and teams, Mockoon Pro supercharges your API development:

• 🔄️ data synchronization and real-time collaboration
• 🤖 AI powered API mocking
• 📃 Access to dozens of ready to use JSON templates.
• 💬 Priority support and training.

Upgrade today and take your API development to the next level.

Mockoon's documentation

You will find Mockoon's documentation on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.

Changelogs

You will find Mockoon applications changelogs on the official website.

Support/feedback

You can discuss all things related to Mockoon, and ask for help, on the official community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our Discord server.

Contributing

If you are interested in contributing to Mockoon, please take a look at the contributing guidelines.

Please also take a look at our Code of Conduct.

Roadmap

If you want to know what will be coming in the next release you can check the global Roadmap.

New releases will be announced on Mockoon's Twitter account @GetMockoon and through the newsletter to which you can subscribe here.

mockoon.com's Issues

Import samples with URL protocol

This would make sample import easier, alongside with clipboard import.

Need mockoon/mockoon#142 to be done first, and sample section to be created #8

Tutorial Read Links 404

The read links on the tutorials page seem to have a typo in the URL. The link associated with the images works fine but the read links add an 's' to '/tutorial/' within the link making it '/tutorials/'. This leads to a 404 page. Just a minor fix but I thought I'd point it out.

Ex:
https://mockoon.com/tutorials/api-mocking-proxy-mode

https://mockoon.com/tutorial/api-mocking-proxy-mode/

Update templating docs with new helpers (base64 / newline)

mockoon/mockoon#331

i am not getting example environment in mockoon.

Earlier mockoon default environment that is example environment was showing on mockoon but now it is not showing.

Update repository URLs with new organization URL

Print form-data from Postman

I want to simulate an upload file in Mockoon.
The body in the docs:

get the value at a given path from the request body if the entering Content-Type is set to application/json or application/x-www-form-urlencoded

I use Postman as the client. But Mockoon can't print what I send. I need form-data to simulate upload file.
In the Postman uploading file can be done just use form-data. However, the content of form-data is recorded if I print {{ body }}.
I wonder if Mockoon can simulate upload file use form-data instead.

Update 'date' templating helper date-fns link to v2

Add explanation for "empty" parameter rule

add example on how to test if a param is empty in a route response rule:

^$|\s+

Create tutorial section

Update someOf helper description in templating tutorials

see mockoon/mockoon#131

Add new helpers to templating documentation

Add now
Update body documentation for use with x-www-form-urlencoded

Allow #xxx markdown links to target commons and CLI repositories

Add documentation for new helpers

See mockoon/mockoon#413

Update features description after v1.5.0

Add OpenAPI import/export info on features list and tutorial

Add page for open weather mock sample

Update rules and route responses docs for route responses randomization

see mockoon/mockoon#269

Update environment logs documentation

• add info about viewing body in an editor

Improve templating documentation

Is your feature request related to a problem? Please describe.
templating doc is cluttered and incomplete

Describe the solution you'd like
Split by helper categories and add missing doc

Add documentation section

Implements custom CSS Tweets to lighten the page

Add page for Giphy mock sample

Modify CORS icon

Use "multiple_stop" instead of "shuffle"
Update documentation screenshots

Add `setVar` and `concat` helpers documentation

See mockoon/commons#8 mockoon/commons#12

Update docs and CLI images after command renaming

See issue https://github.com/mockoon/cli/issues/15
Docs, landing page, and blog post images must be updated

Create CLI landing page

Fix "learn more" links in /features page

Improve templating helpers docs, mainly Faker handlebars wrapping (params vs named params)

Is your feature request related to a problem? Please describe.
How to use Faker helpers is not clear enough, especially the wrapping in handlebars helper with params vs named params.

Describe the solution you'd like
We need a new section on this or at list some examples.
It may be even better to list all the available helpers with examples.

Order docs versions menu by semver

Add "disable templating" documentation

Update route response doc with duplication

Update proxy mode documentation with proxy headers

Split route responses and rules documentation in two pages

Is your feature request related to a problem? Please describe.
Responses rules documentation is long, rules are not really visible

Describe the solution you'd like
Both topics should be split, maybe under the same category

Nav menu cut off on some widths

Came across this small bug that's causing the nav to be cut off from 1200px - 1451px browser width. I believe it's an issue with Bulma's flex-basis: 0 on .nav-right. Happy to submit a PR if you want.

Add samples / examples section

Having a section with mock samples could be useful.
Ability to copy samples data to clipboard with a button would be the minimum to easier the import in Mockoon.

Add Mockoon's twitter link

Add syntax highlighter to docs pages

Is your feature request related to a problem? Please describe.
JSON is not benefiting from prismjs syntax highlighting in the docs

Describe the solution you'd like
Add syntax highlighting to the docs pages

Update to Nextjs v10

Add "cookie" helper to templating tutorial

Update openapi import for sample JSON bodies

see mockoon/mockoon#288

Update templating documentation

• replace dummy JSON by Faker.js
• updates to body helper
  • fetching full body (any content-type)
  • fetching full objects / arrays
  • fetching www-form content with a path
• updates to queryparam helper
  • fetching paths
  • fetching full objects / arrays
  • fetching full query string object

Add Linux new formats and span command

mockoon/mockoon#163

Add multiple route responses tutorial

on the following URL: https://mockoon.com/tutorial/multiple-route-responses/

Add documentation for new dateTimeShift helper

See mockoon/mockoon#355

Add new `objectId` helper to templating docs

See mockoon/mockoon#342

Add docs for helpers new params

mockoon/commons#22
mockoon/commons#23

Update documentation for AND/OR rules operator

See mockoon/mockoon#201

Add documentation for full body match in rules

see mockoon/mockoon#271

Add mock samples pages

Is your feature request related to a problem? Please describe.
We have new mock samples and need to display them on the website

Describe the solution you'd like
create a dynamic list + single mock samples pages like the tutorials

Add note in templating tutorial stating that spaces are important

Space between oneOf and () is important --> oneOf (...)