@kubb/plugin-swr​

With the SWR plugin you can createSWR hooks based on an operation.

Installation​

bun add -d @kubb/plugin-swr

pnpm add -D @kubb/plugin-swr

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

yarn add -D @kubb/plugin-swr

Options​

output​

Specify the export location for the files and define the behavior of the output.

output.path​

Path to the output folder or file that will contain the generated code.

output.barrelType​

Define what needs to be exported, here you can also disable the export of barrel files.

export * from "./gen/petService.ts"

export { PetService } from "./gen/petService.ts"

output.banner​

Add a banner text in the beginning of every file.

output.footer​

Add a footer text at the end of every file.

contentType​

Define which contentType should be used. By default, the first JSON valid mediaType will be used

group​

Grouping makes it possible to combine files in a folder based on specifictype.

Imagine you have the following setup:

group: {  type: 'tag',  name({ group }){    return `${group}Controller`  }}

That will create a structure like this:

.├── src/│   └── petController/│   │   ├── addPet.ts│   │   └── getPet.ts│   └── storeController/│       ├── createStore.ts│       └── getStoreById.ts├── petStore.yaml├── kubb.config.ts└── package.json

group.type​

Define a type where to group the files on.

• 'tag': Use of operation.getTags().at(0)?.name

group.name​

Return the name of a group based on the group name, this will be used for the file and name generation.

client​

client.importPath​

Path to the client import path that will be used to do the API calls.
It will be used asimport client from '${client.importPath}'.
It allows both relative and absolute path but be aware that we will not change the path.

client.dataReturnType​

ReturnType that will be used when calling the client.

• 'data' will return ResponseConfig[data].
• 'full' will return ResponseConfig.

export async function getPetById<TData>(  petId: GetPetByIdPathParams,): Promise<ResponseConfig<TData>["data"]> {  ...}

export async function getPetById<TData>(  petId: GetPetByIdPathParams,): Promise<ResponseConfig<TData>> {  ...}

client.baseURL​

Allows you to set a custom base url for all generated calls.

paramsType​

How to pass your params. Here you can switch between object-style parameters and inline parameters.

• 'object' will return the params and pathParams as an object.
• 'inline' will return the params as comma separated params.

export async function deletePet(  {    petId,    headers,  }: {    petId: DeletePetPathParams['petId']    headers?: DeletePetHeaderParams  },  config: Partial<RequestConfig> = {},) {...}

export async function deletePet(  petId: DeletePetPathParams['petId'],  headers?: DeletePetHeaderParams,  config: Partial<RequestConfig> = {}){  ...}

paramsCasing​

How to style your params, by default no casing is applied.

• 'camelcase' will use camelcase for the params names

export async function deletePet(  petId: DeletePetPathParams['pet_id'],  headers?: DeletePetHeaderParams,  config: Partial<RequestConfig> = {}){...}

export async function deletePet(  pet_id: DeletePetPathParams['pet_id'],  headers?: DeletePetHeaderParams,  config: Partial<RequestConfig> = {}){ ...}

pathParamsType​

How to pass your pathParams.

• 'object' will return the pathParams as an object.
• 'inline' will return the pathParams as comma separated params.

export async function getPetById (  { petId }: GetPetByIdPathParams,) {  ...}

export async function getPetById(  petId: GetPetByIdPathParams,) {  ...}

parser​

Which parser should be used before returning the data.

• 'zod' will use@kubb/plugin-zod to parse the data.
• 'client' will return without parsing the data.

queryKey​

Customize the queryKey.

query​

query.methods​

query.importPath​

mutation​

mutation.methods​

mutation.importPath​

mutationKey​

Customize the mutationKey.

include​

Array containing include parameters to include tags/operations/methods/paths.

export type Include = {  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType'  pattern: string | RegExp}

exclude​

Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

export type Exclude = {  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType'  pattern: string | RegExp}

override​

Array containing override parameters to overrideoptions based on tags/operations/methods/paths.

export type Override = {  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType'  pattern: string | RegExp  options: PluginOptions}

generators​

SeeGenerators for more information on how to use generators.

transformers​

transformers.name​

Customize the names based on the type that is provided by the plugin.

type ResolveType = 'file' | 'function' | 'type' | 'const'

Example​

import {
defineConfig
 } from '@kubb/core'import {
pluginOas
 } from '@kubb/plugin-oas'import {
pluginSwr
 } from '@kubb/plugin-swr'import {
pluginTs
 } from '@kubb/plugin-ts'import {
pluginZod
 } from '@kubb/plugin-zod'export default
defineConfig
({
input
: {
path
: './petStore.yaml',  },
output
: {
path
: './src/gen',  },
plugins
: [
pluginOas
(),
pluginTs
(),
pluginZod
(),
pluginSwr
({
output
: {
path
: './hooks',      },
group
: {
type
: 'tag',
name
: ({
group
 }) => `${
group
}Hooks`,      },
client
: {
dataReturnType
: 'full',      },
parser
: 'zod',    }),  ],})

Links​

• SWR

Contributors

Stijn Van Hulle Nick Williams

Fırat Yalavuz

Samuel Chaim Lev-Ari

Alfred

Changelog