Officialv5.1.5MITkubb >=5.0.0node >=22

@kubb/plugin-vue-query

Generates TanStack Query composables for Vue from your OpenAPI spec, so every read and write is a typed useQuery, useInfiniteQuery, or useMutation.

vue-querytanstack-queryvuecomposablesdata-fetchingcodegenopenapi
Stijn Van Hulle

Stijn Van Hulle

@stijnvanhulle

Downloads
32.6K/ mo
Stars
8
Bundle size
429.8 kB
Updated
10h ago

@kubb/plugin-vue-query generates TanStack Query option factories and cache keys from OpenAPI operations. Set hooks: true to also generate Vue composables with reactive parameters.

Installation

bun add -d @kubb/plugin-vue-query

Dependencies

Add pluginTs and an Axios or Fetch client plugin. Generated output requires @tanstack/vue-query v5 or higher. Configure validation on the client plugin.

Example

kubb.config.ts
import { defineConfig } from 'kubb'
import { pluginTs } from '@kubb/plugin-ts'
import { pluginFetch } from '@kubb/plugin-fetch'
import { pluginVueQuery } from '@kubb/plugin-vue-query'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen' },
  plugins: [
    pluginTs(),
    pluginFetch(),
    pluginVueQuery({ hooks: true }),
  ],
})

Documentation

See also

Call operations