<div align="center"> <h2>MockIt: A tool to quickly create mocked APIs.</h2> <p>Stop wasting time mocking APIs. MockIt gives you an interface to configure and create REAL mocked endpoints for your applications. Whilst you wait for APIS to be built use MockIt to talk to a real service.</> <hr />

Donate ☕

<hr /> <img alt="header" src="./images/demo.gif" /> <h3>Features: Live Reload, Chaos Engineering, Authentication, CORS and more...</h3>

Read the Docs | Edit the Docs

</div> <hr/>

The problem

When building applications you often need to interact with services. When the services are not ready to be consumed you have a few options:

1. Mock out the response with a JSON file
2. Create a mock service yourself
3. Use MockIt.

This solution

This tool was designed to help developers quickly create endpoints for their applications. No need to create a server, just use docker and run this project locally. You can create, edit and manage routes to your API. Every change to the API will be reflected on the server and updated straight away.

This tool comes with a few features out the box:

• CORS
• Basic Authentication
• Chaos Monkey (Unleash a monkey to take down your endpoints)

More information about how it works, its features can be found on the docs.

Read the docs and get started

Getting Started

Make sure you have docker running

git clone https://github.com/boyney123/mockit.git

cd mockit && docker-compose up --build -d

Once everything is up and running go to http://localhost:5000 to see MockIt.

For instructions on how to use MockIt please see the documentation.

Permissions

If you get error: Couldn't connect to Docker daemon at http+docker://localhost - is it running? you might need run with sudo

sudo docker-compose up --build -d

Local install and running tests

If you want to install and run the tests for all apps then you can run this script:

sh install-and-test.sh

If you have any problems with permissions you might need to chmod the file

chmod +x install-and-test.sh && ./install-and-test.sh

Viewing the dashboard, server and API

Once Docker is running you have three applications running on the machine.

1. The client: http://localhost:5000
2. The client-server: http://localhost:4000
3. The MockIt API (this is the server that runs your API): http://localhost:3000

If you want to view the dashboard to get started go to http://localhost:5000.

If you want to interact with your new API go to http://localhost:3000.

For example, if you have a /user route setup, go to http://localhost:3000/user to view the data.

Tools

• nodemon - Listening for changes
• Express
• React
• Docker

Documentation

• Docusaurus

Testing

• jest
• react-testing-library
• supertest

Contributing

If you have any questions, features or issues please raise any issue or pull requests you like.

Donating

If you find this tool useful, feel free to buy me a ☕ 👍

Buy a drink

License

MIT.

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://medium.com/@boyney123"><img src="https://avatars1.githubusercontent.com/u/3268013?v=4" width="100px;" alt="David Boyne"/><br />_{<b>David Boyne</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=boyney123" title="Code">💻</a> <a href="https://github.com/boyney123/mockit/commits?author=boyney123" title="Documentation">📖</a> <a href="#design-boyney123" title="Design">🎨</a> <a href="#ideas-boyney123" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-boyney123" title="Reviewed Pull Requests">👀</a> <a href="#tool-boyney123" title="Tools">🔧</a></td> <td align="center"><a href="https://medium.com/@liran.tal"><img src="https://avatars1.githubusercontent.com/u/316371?v=4" width="100px;" alt="Liran Tal"/><br />_{<b>Liran Tal</b>}</a><br /><a href="#security-lirantal" title="Security">🛡️</a></td> <td align="center"><a href="https://fb.com/RemoveU"><img src="https://avatars1.githubusercontent.com/u/19208123?v=4" width="100px;" alt="Hongarc"/><br />_{<b>Hongarc</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=Hongarc" title="Documentation">📖</a></td> <td align="center"><a href="https://hugo.pro"><img src="https://avatars3.githubusercontent.com/u/180032?v=4" width="100px;" alt="Hugo Locurcio"/><br />_{<b>Hugo Locurcio</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=Calinou" title="Code">💻</a></td> <td align="center"><a href="http://www.andrewroberthall.co.uk"><img src="https://avatars1.githubusercontent.com/u/724328?v=4" width="100px;" alt="Andrew Hall"/><br />_{<b>Andrew Hall</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=FattusMannus" title="Documentation">📖</a></td> <td align="center"><a href="http://grainger.xyz"><img src="https://avatars1.githubusercontent.com/u/1332395?v=4" width="100px;" alt="Peter Grainger"/><br />_{<b>Peter Grainger</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=peterjgrainger" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/wohlben"><img src="https://avatars2.githubusercontent.com/u/9362553?v=4" width="100px;" alt="Ben"/><br />_<b>Ben</b></a><br /><a href="https://github.com/boyney123/mockit/commits?author=wohlben" title="Code">💻</a></td> </tr> <tr> <td align="center"><a href="https://github.com/MCRayRay"><img src="https://avatars1.githubusercontent.com/u/2843957?v=4" width="100px;" alt="MCRayRay"/><br />_{<b>MCRayRay</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=MCRayRay" title="Code">💻</a></td> <td align="center"><a href="https://github.com/fbricon"><img src="https://avatars3.githubusercontent.com/u/148698?v=4" width="100px;" alt="Fred Bricon"/><br />_{<b>Fred Bricon</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=fbricon" title="Code">💻</a></td> <td align="center"><a href="https://blog.missj.club"><img src="https://avatars1.githubusercontent.com/u/19582252?v=4" width="100px;" alt="fliu2476"/><br />_{<b>fliu2476</b>}</a><br /><a href="https://github.com/boyney123/mockit/issues?q=author%3Afliu2476" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/de314"><img src="https://avatars1.githubusercontent.com/u/816693?v=4" width="100px;" alt="David Esposito"/><br />_{<b>David Esposito</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=de314" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/mlaopane"><img src="https://avatars3.githubusercontent.com/u/23735276?v=4" width="100px;" alt="Mickaël"/><br />_{<b>Mickaël</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=mlaopane" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/zecarrera"><img src="https://avatars1.githubusercontent.com/u/4092515?v=4" width="100px;" alt="José Carréra Alvares Neto"/><br />_{<b>José Carréra Alvares Neto</b>}</a><br /><a href="https://github.com/boyney123/mockit/commits?author=zecarrera" title="Code">💻</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CO