https://github.com/Meeshkan/micro-jaymock
Tiny API mocking microservice for generating fake JSON data.
https://github.com/Meeshkan/micro-jaymock
data fake fake-data micro microservice test-data testing
Last synced: 6 months ago
JSON representation
Tiny API mocking microservice for generating fake JSON data.
- Host: GitHub
- URL: https://github.com/Meeshkan/micro-jaymock
- Owner: meeshkan
- Archived: true
- Created: 2019-11-14T01:22:39.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-25T09:24:44.000Z (over 3 years ago)
- Last Synced: 2025-03-13T16:39:17.398Z (8 months ago)
- Topics: data, fake, fake-data, micro, microservice, test-data, testing
- Language: TypeScript
- Homepage: https://jaymock.now.sh
- Size: 9.09 MB
- Stars: 133
- Watchers: 9
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-micro - micro-jaymock - Tiny API mocking microservice for generating fake JSON data (Built with Micro / Utilities)
README
# micro-jaymock
[](https://circleci.com/gh/Meeshkan/micro-jaymock) [](https://github.com/xojs/xo) [](https://codecov.io/gh/Meeshkan/micro-jaymock)
> Tiny API mocking microservice for generating fake JSON data.
## Usage
- Send a `POST` request to [`https://jaymock.now.sh/`](https://jaymock.now.sh) (or [`https://micro-jaymock.now.sh/`](https://micro-jaymock.now.sh)) with your JSON template (see [`jaymock.populate`'s `template` parameter](https://github.com/Meeshkan/jaymock#populatetemplate)) as your request's `body`.
### Examples
#### Using `curl`:
```bash
~ ❯❯❯ curl -X POST \
-d '{ "firstName": "name.firstName", "lastName": "name.lastName" }' \
https://jaymock.now.sh
{"firstName":"Isaac","lastName":"Schultz"}
```
#### Using [`httpie`](https://github.com/jakubroztocil/httpie):
```bash
~ ❯❯❯ http -b POST https://jaymock.now.sh \
firstName=name.firstName lastName=name.lastName ssn=chance.ssn \
_repeat:=3
[
{
"firstName": "Jalyn",
"lastName": "Weimann",
"ssn": "493-64-4894"
},
{
"firstName": "Alvah",
"lastName": "Ziemann",
"ssn": "567-92-8024"
},
{
"firstName": "Bennett",
"lastName": "Russel",
"ssn": "356-24-9256"
}
]
```
#### Using [`request`](https://github.com/request/request) (Node.js):
```js
const request = require('request')
const template = {
firstName: 'name.firstName',
lastName: 'name.lastName',
ipAddresses: 'internet.ip|2'
}
request.post({url: 'https://jaymock.now.sh', json: template}, (error, response, body) => {
if (error) {
/* Handle error */
console.error(error)
}
console.log(body)
/*
{
firstName: 'Kaley',
lastName: 'Muller',
ipAddresses: [ '118.171.253.32', '193.234.186.225' ]
}
*/
})
```
#### Using [`got`](https://github.com/sindresorhus/got) (Node.js):
```js
const got = require('got');
const template = {
name: 'fake({{name.lastName}}, {{name.firstName}} {{name.suffix}})',
ssn: 'chance.ssn',
knownAddresses: {
street: 'address.streetAddress',
city: 'address.city',
zipCode: 'address.zipCode',
_repeat: 2
}
};
(async () => {
const {body} = await got.post('https://jaymock.now.sh', {
json: template,
responseType: 'json'
});
console.log(body);
/*
{
name: 'Goodwin, Libby II',
ssn: '368-52-3834',
knownAddresses: [
{
street: '42483 Citlalli Viaduct',
city: 'West Joeybury',
zipCode: '43966-8850'
},
{
street: '36297 Estella Throughway',
city: 'South Claudie',
zipCode: '39189-1653'
}
]
}
*/
})();
```
#### Using [`requests`](https://github.com/psf/requests) (Python 3):
```py
import requests, json
template = {
"accounts": {
"name": "finance.accountName",
"iban": "finance.iban",
"bic": "finance.bic",
"currentBalance": "finance.amount",
"currency": "finance.currencyName",
"_repeat": 2
}
}
r = requests.post('https://jaymock.now.sh', data = json.dumps(template))
parsedFakeData = json.loads(r.text) # parse for pretty-printing
print(json.dumps(parsedFakeData, indent=4, sort_keys=True))
"""
{
"accounts": [
{
"bic": "WNRUMKJ1",
"currency": "Turkish Lira",
"currentBalance": "37.49",
"iban": "CY70805008804937709053145O66",
"name": "Credit Card Account"
},
{
"bic": "LTJUMXQ1",
"currency": "Somoni",
"currentBalance": "98.10",
"iban": "FI1000486540190178",
"name": "Home Loan Account"
}
]
}
"""
```
## Development
First, clone the repository and install its dependencies:
```bash
~ ❯❯❯ git clone https://github.com/Meeshkan/micro-jaymock.git
~ ❯❯❯ cd micro-jaymock/
~/micro-jaymock ❯❯❯ npm install
```
Subsequently, start the development server:
```bash
~/micro-jaymock ❯❯❯ npm run dev
```
You can then access the service by navigating to [`localhost:3000`](http://localhost:3000).
Alternatively, you can download [`jaymock-cli`](https://github.com/Meeshkan/jaymock-cli) (by running `~ ❯❯❯ npm i -g jaymock-cli`), which allows you to run the development server and, consequently, mock a fake API 'globally' (by simply executing `~ ❯❯❯ jaymock --server`).
## Deployment
[](https://deploy.now.sh/?repo=https://github.com/Meeshkan/micro-jaymock)
Alternatively, to deploy `micro-jaymock` manually:
First, [download `now`](https://zeit.co/download):
```bash
~ ❯❯❯ npm install -g now
```
Then, run `now` from *within* the `micro-jaymock` directory:
```bash
~/micro-jaymock ❯❯❯ now
```
## Related
- [jaymock](https://github.com/Meeshkan/jaymock) - API for this module
- [jaymock-cli](https://github.com/Meeshkan/jaymock-cli) - Mock an API and generate fake JSON test data, right from the terminal
## Contributing
Thanks for wanting to contribute! We will soon have a contributing page
detailing how to contribute. Meanwhile, feel free to star this repository, open issues,
and ask for more features and support.
Please note that this project is governed by the [Meeshkan Community Code of Conduct](https://github.com/meeshkan/code-of-conduct). By participating in this project, you agree to abide by its terms.
## Credits
- [`Faker.js`](https://github.com/Marak/Faker.js) is used as [`jaymock`](https://github.com/Meeshkan/jaymock)'s core fake data generator.
- [`chance`](https://github.com/chancejs/chancejs) is imported as a fake data generator dependency (using [`jaymock.extend`](https://github.com/Meeshkan/jaymock#extendname-body)).
- [`micro`](https://github.com/zeit/micro) is used to serve this HTTP microservice.
## License
MIT © [Meeshkan](http://meeshkan.com/)