@kubb/plugin-faker

@kubb/plugin-faker builds a mock-data factory for every schema in your OpenAPI spec with Faker.js. Call createPet() to get a realistic Pet object. Use the factories in tests, Storybook stories, and local development without a backend.

Installation

bun

bun add -d @kubb/plugin-faker@beta

pnpm

pnpm add -D @kubb/plugin-faker@beta

npm

npm install --save-dev @kubb/plugin-faker@beta

yarn

yarn add -D @kubb/plugin-faker@beta

Dependencies

This plugin depends on @kubb/plugin-ts for the types each factory returns. Keep pluginTs() in the plugins array. No other plugin is required.

Example

kubb.config.ts

import { defineConfig } from 'kubb'
import { pluginFaker } from '@kubb/plugin-faker'
import { pluginTs } from '@kubb/plugin-ts'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen' },
  plugins: [
    pluginTs({
      output: { path: './types' },
    }),
    pluginFaker({
      output: { path: './mocks' },
      seed: [100],
    }),
  ],
})

See also

• Faker.js
• @kubb/plugin-ts
• @kubb/plugin-msw
• Changelog