https://github.com/shanamaid/koa-swagger-mock

It's a middleware for swagger-mock!
https://github.com/shanamaid/koa-swagger-mock

koa middleware moa mockjs swagger swagger-mock

Last synced: 2 months ago
JSON representation

It's a middleware for swagger-mock!

• Host: GitHub
• URL: https://github.com/shanamaid/koa-swagger-mock
• Owner: ShanaMaid
• License: mit
• Created: 2018-03-23T06:34:32.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-19T11:05:59.000Z (almost 6 years ago)
• Last Synced: 2024-10-15T08:22:15.516Z (4 months ago)
• Topics: koa, middleware, moa, mockjs, swagger, swagger-mock
• Language: JavaScript
• Homepage:
• Size: 119 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# koa-swagger-mock

[![build](https://img.shields.io/npm/v/koa-swagger-mock.svg?style=flat-square)](https://www.npmjs.com/package/koa-swagger-mock) 

[![build](https://img.shields.io/npm/l/express.svg)](https://www.npmjs.com/package/koa-swagger-mock)

[![download](https://img.shields.io/npm/dt/koa-swagger-mock.svg?style=flat-square)](https://www.npmjs.com/package/koa-swagger-mock)

[![NPM](https://nodei.co/npm/koa-swagger-mock.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/koa-swagger-mock/)

## Introduce

It's a middleware for swagger-mock!

preview this project, do this!

```

git clone https://github.com/ShanaMaid/koa-swagger-mock

npm install

npm run test

url: localhost:3000/api/pet/1212121212

```

## Usage

`npm install koa-swagger-mock -save`

## Example

```

const Koa = require('koa');

const app = new Koa();

const KoaSwaggerMock = require('../lib/koa-swagger-mock');

const path = require('path');

const fs = require('fs');

const swagger = JSON.parse(

  fs.readFileSync(path.resolve(__dirname, '../json/example.json'), {encoding: 'utf8'})

);

const koaSwagMock = KoaSwaggerMock({

  swagger,

  prefix: '/api'

});

app.use(koaSwagMock.routes());

app.listen(3000);

```

this is mock resp!

`http://localhost:3000/api/pet/findByStatus`

![mock resp](./example/example.png)

## API

### `KoaSwaggerMock({...params})`

* `swagger` - (*Object*) - (required) - api can be one of the following.

    - A Swagger JSON Object.

* `prefix` - (*String*) - (optional) - url prefix.

    - default is `''`