Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boyney123/mockit
A tool to quickly mock out end points, setup delays and more...
https://github.com/boyney123/mockit
api http json mock stub tool
Last synced: 21 days ago
JSON representation
A tool to quickly mock out end points, setup delays and more...
- Host: GitHub
- URL: https://github.com/boyney123/mockit
- Owner: boyney123
- License: mit
- Created: 2019-01-16T17:42:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T07:05:20.000Z (over 1 year ago)
- Last Synced: 2024-10-01T22:22:15.031Z (about 1 month ago)
- Topics: api, http, json, mock, stub, tool
- Language: JavaScript
- Homepage: https://mockit.netlify.com/
- Size: 30.1 MB
- Stars: 1,584
- Watchers: 16
- Forks: 84
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - mockit - A tool to quickly mock out end points, setup delays and more... (JavaScript)
README
MockIt: A tool to quickly create mocked APIs.
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.>
[](https://travis-ci.org/boyney123/mockit)
[](https://codecov.io/gh/boyney123/mockit)
[](https://app.netlify.com/sites/mockit/deploys)
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[](#contributors-)
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]
[Donate ☕](https://www.paypal.me/boyney123/5)
Features: Live Reload, Chaos Engineering, Authentication, CORS and more...
[Read the Docs](https://mockit.netlify.com/) | [Edit the Docs](https://github.com/boyney123/mockit-docs)
# 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](https://mockit.netlify.com/)
# Getting Started
_Make sure you have docker running_
```sh
git clone https://github.com/boyney123/mockit.git
```
```sh
cd mockit && docker-compose up --build -d
```
Once everything is up and running go to [http://localhost:5000](http://localhost:5000) to see MockIt.
For instructions on how to use MockIt please see the [documentation](https://mockit.netlify.com/docs/getting-started/routes).
## 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](http://localhost:5000)
2. The client-server: [http://localhost:4000](http://localhost:4000)
3. The MockIt API (this is the server that runs your API): [http://localhost:3000](http://localhost:3000)
If you want to view the dashboard to get started go to [http://localhost:5000](http://localhost:5000).
If you want to interact with your new API go to [http://localhost:3000](http://localhost:3000).
For example, if you have a `/user` route setup, go to [http://localhost:3000/user](http://localhost:3000/user) to view the data.
# Tools
- [nodemon - Listening for changes](https://github.com/remy/nodemon)
- [Express](https://expressjs.com/)
- [React](https://reactjs.org/)
- [Docker](https://www.docker.com/)
## Documentation
- [Docusaurus](https://docusaurus.io/)
## Testing
- [jest](https://jestjs.io/)
- [react-testing-library](https://github.com/kentcdodds/react-testing-library)
- [supertest](https://github.com/visionmedia/supertest)
# Contributing
If you have any questions, features or issues please raise any issue or pull requests you like.
[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg
[spectrum]: https://spectrum.chat/explore-tech
[license-badge]: https://img.shields.io/github/license/boyney123/mockit.svg?color=yellow
[license]: https://github.com/boyney123/react.explore-tech.org/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[github-watch-badge]: https://img.shields.io/github/watchers/boyney123/mockit.svg?style=social
[github-watch]: https://github.com/boyney123/mockit/watchers
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20mockit%20by%20%40boyney123%20https%3A%2F%2Fgithub.com%2Fboyney123%2Fmockit%20%F0%9F%91%8D
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/boyney123/mockit.svg?style=social
[github-star-badge]: https://img.shields.io/github/stars/boyney123/mockit.svg?style=social
[github-star]: https://github.com/boyney123/mockit/stargazers
# Donating
If you find this tool useful, feel free to buy me a ☕ 👍
[Buy a drink](https://www.paypal.me/boyney123/5)
# License
MIT.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
David Boyne
💻 📖 🎨 🤔 👀 🔧
Liran Tal
🛡️
Hongarc
📖
Hugo Locurcio
💻
Andrew Hall
📖
Peter Grainger
📖
Ben
💻
MCRayRay
💻
Fred Bricon
💻
fliu2476
🐛
David Esposito
📖
Mickaël
📖
José Carréra Alvares Neto
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!