# @swarmica/msw-auto-mock

> Generate mock data from OpenAPI descriptions for msw

Latest version **1.0.0** (published 2025-12-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @swarmica/msw-auto-mock
pnpm add @swarmica/msw-auto-mock
yarn add @swarmica/msw-auto-mock
bun add @swarmica/msw-auto-mock
```

Provides the command `msw-auto-mock`.

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2025-12-29 |
| First published | 2025-12-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 9.3 MB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | zoubingwu |
| Maintainers | obarishevskaya, alexplex, msudyin |
| Keywords | msw, mock, service-worker, openapi |

## Links

- npm: https://www.npmjs.com/package/@swarmica/msw-auto-mock
- Repository: https://github.com/Swarmica/msw-auto-mock
- Issues: https://github.com/Swarmica/msw-auto-mock/issues
- npm.io page: https://npm.io/package/@swarmica/msw-auto-mock

## Dependencies (7)

- [cac](https://npm.io/package/cac.md) 6.7.14
- [lodash](https://npm.io/package/lodash.md) 4.17.21
- [prettier](https://npm.io/package/prettier.md) 3.3.2
- [ts-pattern](https://npm.io/package/ts-pattern.md) 5.2.0
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) 9.0.0
- [swagger2openapi](https://npm.io/package/swagger2openapi.md) 7.0.8
- [@apidevtools/swagger-parser](https://npm.io/package/@apidevtools/swagger-parser.md) 10.1.0

## Alternatives

- [pagerjs](https://npm.io/package/pagerjs.md) — 60 weekly downloads
- [whistle.savefor-mock](https://npm.io/package/whistle.savefor-mock.md) — 4 weekly downloads
- [interceptpilot-mcp](https://npm.io/package/interceptpilot-mcp.md) — 0 weekly downloads
- [fakeforge-br](https://npm.io/package/fakeforge-br.md) — 0 weekly downloads
- [screenframe3d](https://npm.io/package/screenframe3d.md) — 0 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2025-12-29

## README

# @swarmica/msw-auto-mock

A cli tool to generate **stable** mock data from OpenAPI descriptions for [msw](https://github.com/mswjs/msw).

## Why

We already have all the type definitions from OpenAPI spec so hand-writing every response resolver is completely unnecessary.

Install:

```sh
npm i @swarmica/msw-auto-mock -D
```

Read from your OpenAPI descriptions and output generated code:

```sh
# can be http url or a file path on your machine, support both yaml and json.
npx msw-auto-mock http://your_openapi.json -o ./mock
```

For Node.js integration, you can import from `your_output/node.js`:

```js
import { server } from './mock/node.js';
```

## Options

- `-o, --output`: specify output file path or output to stdout.
- `-t, --includes <keywords>`: specify keywords to match if you want to generate mock data only for certain requests, multiple keywords can be seperated with comma.
- `-e, --excludes <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.
- `-c, --codes <keywords>`: comma separated list of status codes to generate responses for
- `--typescript`: Generate TypeScript files instead of JavaScript files.
- `-h, --help`: show help info.

---
_Source: https://npm.io/package/@swarmica/msw-auto-mock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._