百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
M

msw-auto-mock

> 编程语言
开源

一个 CLI 工具,用于从 OpenAPI 定义中生成随机模拟数据,用于 msw。

385 stars0 点赞2 次浏览
访问官网GitHub

工具介绍

一个 CLI 工具,用于从 OpenAPI 定义中生成随机模拟数据,用于 msw。

msw-auto-mock

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.

Generative AI Support

Since v0.19.0, msw-auto-mock can use generative AI to generate mock data instead of faker.

AI is configured via your package.json (or any config file supported by cosmiconfig) under the msw-auto-mock key:

json
{
  "msw-auto-mock": {
    "ai": {
      "enable": true,
      "provider": "openai",
      "openai": {
        "apiKey": "process.env.OPENAI_API_KEY",
        "model": "gpt-4o"
      }
    }
  }
}

Providers and Required Fields

Currently supported providers: openai, azure, anthropic.

When ai.enable is true, you must provide the model/deployment for the selected provider:

  • provider: "openai" requires ai.openai.model
  • provider: "azure" requires ai.azure.deployment
  • provider: "anthropic" requires ai.anthropic.model

If a required field is missing, generation fails fast with a clear error (instead of generating broken code).

How Config Values Are Interpreted

The AI config values are strings in JSON, but they are used to generate JavaScript code. msw-auto-mock supports two styles:

  • Expression strings: values that start with process.env. or import.meta.env. (or Deno.env.) are treated as JavaScript expressions and injected as-is.
  • Literal strings: everything else is treated as a string literal and will be automatically quoted in the generated code.

This means you can write:

  • "model": "gpt-4o" (literal string; recommended)
  • "apiKey": "process.env.OPENAI_API_KEY" (expression string)

Full Type Definition

typescript
interface Config {
  ai?: {
    enable?: boolean;
    provider: 'openai' | 'azure' | 'anthropic';
    openai?: {
      baseURL?: string;
      apiKey?: string;
      model?: string;
    };
    azure?: {
      apiKey?: string;
      resource?: string;
      deployment?: string;
    };
    anthropic?: {
      apiKey?: string;
      model?: string;
    };
  };
}

[!IMPORTANT] For security, keep API keys in environment variables and reference them via process.env.* / import.meta.env.* in your config. You no longer need to wrap model names in extra quotes; "model": "gpt-4o" is valid.

Usage

This tool also requires @faker-js/faker >= 8 and msw >= 2.

Install:

bash
yarn add msw-auto-mock @faker-js/faker -D

Read from your OpenAPI descriptions and output generated code:

bash
# 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

Integrate with msw, see Mock Service Worker's doc for more detail:

bash
# Install msw
yarn add msw --dev

# Init service worker
npx msw init public/ --save

Then import those mock definitions in you app entry:

javascript
import { worker } from './mock/browser.js';

await worker.start();

For conditional mocking:

javascript
async function enableMocking() {
  if (process.env.NODE_ENV !== 'development') {
    return;
  }
  const { worker } = await import('./mock/browser');
  // `worker.start()` returns a Promise that resolves
  // once the Service Worker is up and ready to intercept requests.
  return worker.start();
}

function mountApp() {
  const root = createRoot(document.getElementById('root'));
  root.render();
}

enableMocking().then(mountApp);

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

javascript
import { worker } from './mock/node.js';

For React Native integration, you can import from your_output/native.js:

javascript
import { worker } from './mock/native.js';

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 : specify max array length in response, default value is 20, it'll cost some time if you want to generate a huge chunk of random data.
  • -t, --includes : specify keywords to match if you want to generate mock data only for certain requests, multiple keywords can be seperated with comma.
  • -e, --excludes : 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.
  • --static: By default it will generate dynamic mocks, use this flag if you need it to be static.
  • -c, --codes : comma separated list of status codes to generate responses for
  • --typescript: Generate TypeScript files instead of JavaScript files.
  • -h, --help: show help info.

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

TypeScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言