MSW

Generates typed MSW request handlers from your OpenAPI spec, one per operation. Use them to mock the API in tests and during local development.

Each handler returns the data you pass to it. With parser: 'faker', it falls back to mock data from @kubb/plugin-faker when you pass none.

Installation

bun add -d @kubb/plugin-msw

pnpm add -D @kubb/plugin-msw

npm install --save-dev @kubb/plugin-msw

yarn add -D @kubb/plugin-msw

Or run kubb add plugin-msw to install the version the Kubb registry pins and add pluginMsw() to kubb.config.ts.

Setup

• Add @kubb/plugin-ts.
• Add @kubb/plugin-faker when you set parser: 'faker'. The default data parser does not need it.
• Install MSW v2 or higher in the app that uses the generated code.

Options worth knowing

• parser sets where the response body comes from: data (default) or faker.
• handlers writes a handlers.ts file that exports every handler, ready to spread into setupServer or setupWorker.
• baseURL is prepended to the path each handler matches.