Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orels1/puremock
A zero-dependency mock api server ⚡️
https://github.com/orels1/puremock
mock nodejs rest-api zero-dependency
Last synced: 22 days ago
JSON representation
A zero-dependency mock api server ⚡️
- Host: GitHub
- URL: https://github.com/orels1/puremock
- Owner: orels1
- Created: 2018-10-21T20:45:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-29T02:50:55.000Z (about 6 years ago)
- Last Synced: 2024-03-26T00:45:49.883Z (8 months ago)
- Topics: mock, nodejs, rest-api, zero-dependency
- Language: JavaScript
- Homepage:
- Size: 37.1 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
Puremock
⚡️ A zero-dependency mock api server ⚡️
Built with ❤︎ by
orels1
## Motivation
Hacktoberfest, mainly, but also just a search for a package like this that took me more than an hour and ultimately pointed me to Mockoon (which is great, btw, [check it out](https://mockoon.com/)). But I figured I should make this too, since I have a soft spot for cute zero-dep tools, so here we are. Hope you'll enjoy using it as much, as I did developing it.
## Installation
```shell
# with npm
npm i -g puremock
#with yarn
yarn global add puremock
```
## Usage
### Create a mock file
By default puremock will look for `mockApi.json` in the project root. But you can also supply a different path (see below).
```json
{
"GET /": {
"response": {
"status": "ok"
}
},
"GET /error": {
"status": 503,
"header": {
"x-powered-by": "mock-api-server"
},
"response": {
"error": "Internal Server Error"
}
},
"GET /articles/:name": {
"response": {
"title": "Foobar"
}
}
}
```
That's about it as far as configuration goes. You can supply any kind of HTTP method, set response codes and headers.
Path params are supported (with multiple levels), so you can have endpoints like `/root/:param1/:param2` or `/root/exact/:param1` and so on. Useful when you have a bunch of dynamic IDs your app requests, but you don't care if the same thing is being returned.
Check `example.json` for references.
Default response code is 200, and the `Content-Type` header is set to `application/json`.
### Start the server
By default the server will start at `localhost:3000`.
```shell
# uses a mockApi.json in the project root
puremock
# you can pass a custom path to a mock file
puremock ./mocks/api.json
# port customization is also supported
puremock --port 4000
```
### Contribute
There are still things we can add while staying lightweight and zero-dependency:
- [x] Add a mock file hot-reload
- [x] Support for dynamic urls (i.e. `/posts/:id)
- [ ] Add a set of prebuilt error responses so users can just supply `status: 503) to get a meaningful response object without defining it
- [ ] Improve the watcher logic (it fails from time to time so I have a bunch of retries there)
The package is auto-published with the latest tag in the package.json when merged into `master`.