gen-msw-mock-comm
update
- generate mocking data only 200 status response
- create each mock api handler file
A cli tool to generate random mock data from OpenAPI descriptions for msw.
Why
We already have all the type definitions from OpenAPI spec so hand-writing every response resolver is completely unnecessary.
Usage
This tool also requires @faker-js/faker >= v7.
Install:
yarn add gen-msw-mock-comm @faker-js/faker -D
Read from your OpenAPI descriptions and output generated code:
# can be http url or a file path on your machine, support both yaml and json.
npx gen-msw-mock-comm http://your_openapi.json -o ./mock.js
See here for generated code with Github API example. The msw mocking handlers was generated by following command:
npx gen-msw-mock-comm https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-3.3/ghes-3.3.json --output ./example/src/mock.ts
Integrate with msw, see Mock Service Worker's doc for more detail:
# Install msw
yarn add msw --dev
# Init service worker
npx msw init public/ --save
Then import those mock definitions in you app entry:
import { startWorker } from './mock';
if (process.env.NODE_ENV === 'development') {
startWorker();
}
Run you app then you'll see a successful activation message from Mock Service Worker in your browser's console.
Options
-
-o, --output
: specify output file path or output to stdout. -
-m, --max-array-length <number>
: specify max array length in response, it'll cost some time if you want to generate a huge chunk of random data. -
-t, --include <keywords>
: specify keywords to match if you want to generate mock data only for certain requests, multiple keywords can be seperated with comma. -
-e, --exclude <keywords>
: specify keywords to exclude, multiple keywords can be seperated with comma. -
--base-url
: output code with specified base url or fallback to server host specified in OpenAPI. -
-h, --help
: show help info.