https://github.com/ryosukecla/mockingcat

Build a mock api server with zero-conf at lightning speed
https://github.com/ryosukecla/mockingcat

fastify mock nodejs server zero-configuration zeroconf

Last synced: 20 days ago
JSON representation

Build a mock api server with zero-conf at lightning speed

• Host: GitHub
• URL: https://github.com/ryosukecla/mockingcat
• Owner: RyosukeCla
• License: mit
• Created: 2018-07-30T09:58:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-02T14:33:53.000Z (over 6 years ago)
• Last Synced: 2024-12-14T00:39:39.399Z (about 2 months ago)
• Topics: fastify, mock, nodejs, server, zero-configuration, zeroconf
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/mockingcat
• Size: 224 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Mockingcat [![Build Status](https://travis-ci.org/RyosukeCla/mockingcat.svg?branch=master)](https://travis-ci.org/RyosukeCla/mockingcat)

> Build a mock api server with zero-conf at lightning speed

## Getting started

### #1 setup

install mockingcat (or use npx)

```

$ npm i -g mockingcat

# or

$ npm i -D mockingcat

```

make `mock` dir to project path

```

$ mkdir mock

```

### #2 start mockingcat

```

$ mockingcat

# or

$ npx mockingcat

```

### #3 make mock api - 1

make file `mock/get.js`

```

$ touch mock/get.js

```

now, you can access to mock/get

```

$ curl http://localhost:8090/mock/get

> {"message":"not implemented yet"}

```

next, implement `mock/get.js`

```js

module.exports = {

  method: 'GET',

  handler (request, reply) {

    reply.send({ message: 'hello, world!' })

  }

}

```

access to mock/get

```

$ curl http://localhost:8090/mock/get

> {"message":"hello, world!"}

```

### #4 make mock api - 2

next, make `mock/user/_id.js`, and append this

```js

module.exports = {

  method: 'GET',

  handler (request, reply) {

    reply.send(request.params)

  }

}

```

you can access to mock/user/_id

```

$ curl http://localhost:8090/mock/user/hello

> {"id": "hello"}

```

## Detail

### config (default)

`mockingcat.config.js`

```js

module.exports = {

  port: 8090,

  srcDir: './mock',

  baseUrl: '/mock',

  verbose: true,

  middlewares: [], // fastify middleware

  ignore: [/node_modules/]

}

```

### mock file (default)

- module.exports: `{ fastify route options }` or `Array<{ fastify route options }>`

```js

module.exports = {

  method: 'GET',

  url: baseUrl + mockFilepath

  handler (request, reply) {

    reply.send({ message: 'not implemented yet' })

  }

}

```

you can define mock file as fastify route option.

- [DOC: fastify route options](https://github.com/fastify/fastify/blob/master/docs/Routes.md#full-declaration)

### CLI

```

$ mockingcat --help

Mockingcat

  --help     (-h)

  --version  (-v)

  --port     (-p) : 8090

  --srcdir   (-s) : ./mock

  --baseurl  (-b) : /mock

  --verbose  (-v) : true

```

### Examples

- [example](./example)