Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fullpipe/jmock
Simple and easy to use json/post API mock server
https://github.com/fullpipe/jmock
json-server mock-server
Last synced: about 4 hours ago
JSON representation
Simple and easy to use json/post API mock server
- Host: GitHub
- URL: https://github.com/fullpipe/jmock
- Owner: fullpipe
- License: mit
- Created: 2019-01-02T09:51:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-19T20:46:21.000Z (10 months ago)
- Last Synced: 2024-06-20T12:04:57.351Z (5 months ago)
- Topics: json-server, mock-server
- Language: Go
- Size: 264 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jmock
[](https://github.com/fullpipe/jmock)
[](https://cloud.docker.com/repository/docker/fullpipe/jmock)
Simple and easy to use json/post API mock server
## Install
Install binary
```sh
go install github.com/fullpipe/jmock@latest
```
## Usage
First create mocks collection file some where in your project. Use [standard
wildcards](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm) for
request matching. For example `./mocks/users.json`:
```json
[
{
"name": "Allow CORS",
"request": {
"method": "OPTIONS",
"priority": 100
},
"response": {
"code": 204,
"headers": {
"Access-Control-Allow-Origin": "*",
"Access-Control-Allow-Headers": "*"
}
}
},
{
"request": {
"method": "POST",
"headers": {
"Authorization": "Bearer *"
},
"url": "/api/users",
"json": {
"name": "*"
}
},
"response": {
"code": 200
}
},
{
"request": {
"method": "GET",
"url": "/api/users/*"
},
"response": {
"code": 200,
"json": {
"name": "John Doe"
}
}
},
{
"request": {
"method": "GET",
"url": "/api/users/7",
"priority": 42
},
"response": {
"code": 200,
"file": "data/user-7.json"
}
},
{
"name": "Get posts list",
"request": {
"method": "GET",
"url": "/api/posts"
},
"proxy": "http://realapi.loc"
}
]
```
Start jmock server
```sh
jmock "./mocks/*.json" --port 9090 --watch
```
Thats it your fake api is ready. Check the request
```sh
curl localhost:9090/api/users/1
```
Output
```json
{
"name": "John Doe"
}
```
### Usage with docker
Run mock server
```sh
docker run -p 9090:9090 -v ${PWD}/mocks:/mocks fullpipe/jmock
```
Or if you need to watch files
```sh
docker run -p 9090:9090 -v ${PWD}/mocks:/mocks fullpipe/jmock /mocks/*.json --port 9090 --watch
```
Or with docker-compose
```yaml
services:
api:
image: fullpipe/jmock
command: "/mocks/*.json --port 9090 --watch"
ports:
- "9090:9090"
volumes:
- ./mocks:/mocks
```
## Mocks
Mock consists of 3 blocks `request`, `response`, `proxy`.
Also you could use `name` to name it.
### Request
You could match request by:
```jsonc
"request": {
"method": "POST", // http method
"url": "/api/users/*", // query path
"headers": {
"Authorization": "Bearer *"
},
"query" { // get params
"country": "R*"
},
"post": { // post variables
"first_name": "Jo*",
"last_name": "?oe"
},
"json": { // JSON request body
"name": "*",
"gender": "?"
},
"priority": 42 // high number for more "sticky" requests
}
```
### Response
For matched request server returns response:
```jsonc
"response": {
"code": 200, // status code
"body": "plain text or html", // response body
"json": { // OR response body with json
"name": "John Doe"
},
"file": "data/user-7.json", // OR path to a file with data for response body
"headers": { // add response headers if required
"Access-Control-Allow-Origin": "*"
}
}
```
### Proxy (optional)
If you get one mock working. You could use `proxy` to
bypass matched request to real API.
```json
"proxy": "http://realapihost.loc"
```
## Examples
### JSON RPC 2.0
```json
[
{
"name": "User registration mock",
"request": {
"mehtod": "POST",
"url": "/rpc",
"json": {
"jsonrpc": "2.0",
"method": "registerUser",
"id": 1,
"params": {
"email": "*"
}
}
},
"response": {
"code": 200,
"json": {
"jsonrpc": "2.0",
"result": {
"user_id": "15"
},
"id": 1
}
}
}
]
```