@kubb/swagger 🦙

With the Swagger plugin, you can create a JSON schema out of a Swagger file. Inside this package, you can also use some utils to create your own Swagger plugin. We already provide a react-query plugin but if you want to create a plugin for SWR you can use this package to get the core utils.(check if a schema is v2 or v3, validate the schema, generate a OAS object, ...).

---

We are using Oas to convert a YAML/JSON to an Oas class(see oasParser) that will contain a lot of extra logic(read the $ref, get all the operations, get all models, ...).

The Swagger plugin also contains some classes and functions that can be used in your own plugin that needs Swagger:

• For example, we have getReference that will return the ref based on the spec.

• Next to that we also have the class OperationGenerator. This class contains the building blocks of getting the request, response, params, ....
  Just call this.getSchemas and you will retrieve an object contains all the info you need to set up a TypeScript type, React-Query hook,....

Installation

bun

bun add @kubb/swagger

pnpm

pnpm add @kubb/swagger

npm

npm install @kubb/swagger

yarn

yarn add @kubb/swagger

Options

validate

Validate your input based on @apidevtools/swagger-parser

INFO

Type: boolean
Default: true

kubb.config.js

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({ validate: true }),
  ],
})

output

output.path

Relative path to save the JSON models.
False will not generate the schema JSONs.

INFO

Type: string | false
Default: 'schemas'

output string

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({
      output: {
        path: './json',
      },
    }),
  ],
})

output false

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({ output: false }),
  ],
})

output.path

Output for the generated doc, we are using https://redocly.com/ for the generation

INFO

Type: string | false
Default: 'docs.html'

docs string

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({
      docs: {
        path: './docs/index.html',
      },
    }),
  ],
})

docs false

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({ docs: false }),
  ],
})

serverIndex

Which server to use from the array of servers.url[serverIndex]

For example 0 will return http://petstore.swagger.io/api and 1 will return http://localhost:3000

INFO

Type: number
Default: 0

OpenAPI

openapi: 3.0.3
info:
  title: Swagger Example
  description:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: http://petstore.swagger.io/api
- url: http://localhost:3000

serverIndex 0

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({ serverIndex: 0 }), // use of `http://petstore.swagger.io/api`
  ],
})

serverIndex 1

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({ serverIndex: 1 }), // use of `http://localhost:3000`
  ],
})

contentType

Override contentType that will be used for requests and responses.

type

export type contentType = 'application/json' | (string & {})

INFO

Type: contentType

kubb.config.js

import { defineConfig } from '@kubb/core'
import { definePlugin as createSwagger } from '@kubb/swagger'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    createSwagger({ contentType: 'application/json' }),
  ],
})

Depended

• @kubb/core

Links

• Oas