Skip to content

Handlers you fill from tests ​

Return an empty typed payload from each handler by keeping parser on its default 'data'. Each test supplies the response body it needs, and the type comes from @kubb/plugin-ts.

kubb.config.ts
typescript
import { defineConfig } from 'kubb/config'
import { pluginTs } from '@kubb/plugin-ts'
import { pluginMsw } from '@kubb/plugin-msw'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen', clean: true },
  plugins: [
    pluginTs({ output: { path: 'types', mode: 'directory' } }),
    pluginMsw({
      output: { path: 'handlers', mode: 'directory' },
      parser: 'data',
    }),
  ],
})

Output example ​

src/gen/handlers/getPetByIdHandler.ts
typescript
import type { GetPetByIdResponse } from '../types/GetPetById'
import { http } from 'msw'

export function getPetByIdHandler(data?: GetPetByIdResponse | ((info: Parameters<Parameters<typeof http.get>[1]>[0]) => Response | Promise<Response>)) {
  return http.get(`/pet/:petId\\:search`, function handler(info) {
    if (typeof data === 'function') return data(info)

    return new Response(JSON.stringify(data), {
      status: 200,
      headers: { 'Content-Type': 'application/json' },
    })
  })
}
usage.ts
typescript
import { setupServer } from 'msw/node'
import { getPetByIdHandler } from './src/gen/handlers/getPetByIdHandler'

// Each test supplies its own payload for the typed response.
const server = setupServer(getPetByIdHandler({ id: 1, name: 'Rex' }))