@kubb/adapter-oas

Documentation · Report Bug · Request Feature

@kubb/adapter-oas

OpenAPI and Swagger adapter for Kubb

Parses and validates Swagger 2.0, OpenAPI 3.0, and OpenAPI 3.1 specifications and transforms them into a @kubb/ast RootNode for downstream code generation plugins.

Installation

bun add @kubb/adapter-oas
# or
pnpm add @kubb/adapter-oas
# or
npm install @kubb/adapter-oas

Usage

Use adapterOas inside your kubb.config.ts:

import { defineConfig } from 'kubb'
import { adapterOas } from '@kubb/adapter-oas'

export default defineConfig({
  input: './openapi.yaml',
  output: {
    path: './src/gen',
  },
  adapter: adapterOas(),
})

input accepts a file path, a URL, an inline JSON or YAML string, or a parsed spec object.

API

adapterOas(options?)

Creates the OAS adapter instance. Pass it as adapter in defineConfig.

adapterOasName

The adapter's name, 'oas'. Use it to identify this adapter in a Kubb config.

Types

The package re-exports the OpenAPI types it works with: ContentType, DiscriminatorObject, Document, MediaTypeObject, Operation, ReferenceObject, ResponseObject, and SchemaObject. Its own option types are AdapterOas, AdapterOasOptions, and AdapterOasResolvedOptions.

Supporting Kubb

Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:

• Become a Sponsor on GitHub
• See sponsorship tiers and our sponsors

License

MIT