diff --git a/docs/plugins/swagger-client/index.md b/docs/plugins/swagger-client/index.md index b3a4a9bce..88248c868 100644 --- a/docs/plugins/swagger-client/index.md +++ b/docs/plugins/swagger-client/index.md @@ -12,19 +12,19 @@ With the Swagger client plugin you can create [Axios](https://axios-http.com/doc ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-client ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-client ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-client ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-client ``` @@ -50,18 +50,26 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped clients. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `clients/{{tag}}Controller` => `clients/PetController`
Default: `${output}/{{tag}}Controller` +::: #### exportAs +::: v-pre Name to be used for the `export * as {{exportAs}} from './` +::: +::: v-pre Type: `string`
Default: `"{{tag}}Service"` +::: ### client Path to the client that will be used to do the API calls. diff --git a/docs/plugins/swagger-faker.md b/docs/plugins/swagger-faker.md index 3aaad89b4..74e2acb72 100644 --- a/docs/plugins/swagger-faker.md +++ b/docs/plugins/swagger-faker.md @@ -12,19 +12,19 @@ With the Swagger Faker plugin you can use [Faker](https://fakerjs.dev/) to creat ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-faker ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-faker ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-faker ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-faker ``` @@ -51,18 +51,24 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped Faker mocks. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `mocks/{{tag}}Controller` => `mocks/PetController`
Default: `${output}/{{tag}}Controller` +::: #### exportAs Name to be used for the `export * as {{exportAs}} from './` +::: v-pre Type: `string`
Default: `"{{tag}}Mocks"` +::: ### skipBy Array containing skipBy paramaters to exclude/skip tags/operations/methods/paths. diff --git a/docs/plugins/swagger-msw.md b/docs/plugins/swagger-msw.md index 87dc94ad7..d1541f2ee 100644 --- a/docs/plugins/swagger-msw.md +++ b/docs/plugins/swagger-msw.md @@ -12,19 +12,19 @@ With the MSW plugin you can use [MSW](https://mswjs.io/) to create API mocks bas ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-msw ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-msw ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-msw ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-msw ``` @@ -51,18 +51,24 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped MSW mocks. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `mocks/{{tag}}Controller` => `mocks/PetController`
Default: `${output}/{{tag}}Controller` +::: #### exportAs Name to be used for the `export * as {{exportAs}} from './` +::: v-pre Type: `string`
Default: `"{{tag}}Handlers"` +::: ### skipBy Array containing skipBy paramaters to exclude/skip tags/operations/methods/paths. diff --git a/docs/plugins/swagger-swr.md b/docs/plugins/swagger-swr.md index 3377e64b6..2b7f293de 100644 --- a/docs/plugins/swagger-swr.md +++ b/docs/plugins/swagger-swr.md @@ -12,19 +12,19 @@ With the Swagger SWR plugin you can create [SWR hooks](https://swr.vercel.app/) ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-swr ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-swr ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-swr ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-swr ``` @@ -49,18 +49,26 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped SWR hooks. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `hooks/{{tag}}Controller` => `hooks/PetController`
Default: `${output}/{{tag}}Controller` +::: #### exportAs +::: v-pre Name to be used for the `export * as {{exportAs}} from './` +::: +::: v-pre Type: `string`
Default: `"{{tag}}SWRHooks"` +::: ### client Path to the client that will be used to do the API calls. diff --git a/docs/plugins/swagger-tanstack-query.md b/docs/plugins/swagger-tanstack-query.md index 8adda43e7..c51e288a6 100644 --- a/docs/plugins/swagger-tanstack-query.md +++ b/docs/plugins/swagger-tanstack-query.md @@ -8,7 +8,7 @@ outline: deep # @kubb/swagger-tanstack-query -With the Swagger Tanstack Query plugin you can create: +With the Swagger Tanstack Query plugin you can create: - [react-query](https://tanstack.com/query/latest/docs/react) hooks based on an operation in the Swagger file. - [solid-query](https://tanstack.com/query/latest/docs/solid) primitives based on an operation in the Swagger file. - [svelte-query](https://tanstack.com/query/latest/docs/svelte) primitives based on an operation in the Swagger file. @@ -18,19 +18,19 @@ With the Swagger Tanstack Query plugin you can create: ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-tanstack-query ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-tanstack-query ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-tanstack-query ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-tanstack-query ``` @@ -55,18 +55,26 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped @tanstack/query hooks. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `hooks/{{tag}}Controller` => `hooks/PetController`
Default: `${output}/{{tag}}Controller` +::: #### exportAs +::: v-pre Name to be used for the `export * as {{exportAs}} from './` +::: +::: v-pre Type: `string`
Default: `"{{tag}}Hooks"` +::: ### client Path to the client that will be used to do the API calls. @@ -102,7 +110,7 @@ Type: `'react' | 'solid' | 'svelte' | 'vue'`
Default: `"react"` ### infinite -When set, an infiniteQuery is getting created, example: +When set, an infiniteQuery is getting created, example: ```typescript { output: './clients/hooks', diff --git a/docs/plugins/swagger-ts.md b/docs/plugins/swagger-ts.md index 1bf0a7f41..6f1fee7f3 100644 --- a/docs/plugins/swagger-ts.md +++ b/docs/plugins/swagger-ts.md @@ -12,19 +12,19 @@ With the Swagger TypeScript plugin you can create [TypeScript](https://www.types ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-ts ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-ts ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-ts ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-ts ``` @@ -49,12 +49,16 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped TypeScript Types. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `models/{{tag}}Controller` => `models/PetController`
Default: `${output}/{{tag}}Controller` +::: ### enumType Choose to use `enum` or `as const` for enums.
@@ -74,7 +78,7 @@ date: string ``` ```typescript ['date'] -date: Date +date: Date ``` ::: diff --git a/docs/plugins/swagger-zod.md b/docs/plugins/swagger-zod.md index 492a2bbf6..2bcf616fe 100644 --- a/docs/plugins/swagger-zod.md +++ b/docs/plugins/swagger-zod.md @@ -12,19 +12,19 @@ With the Swagger Zod plugin you can use [Zod](https://zod.dev/) to validate your ::: code-group -```shell [bun ] +```shell [bun ] bun add @kubb/swagger-zod ``` -```shell [pnpm ] +```shell [pnpm ] pnpm add @kubb/swagger-zod ``` -```shell [npm ] +```shell [npm ] npm install @kubb/swagger-zod ``` -```shell [yarn ] +```shell [yarn ] yarn add @kubb/swagger-zod ``` @@ -50,19 +50,26 @@ Type: `'tag'`
Required: `true` #### output +::: v-pre Relative path to save the grouped Zod schemas. `{{tag}}` will be replaced by the current tagName. +::: +::: v-pre Type: `string`
Example: `zod/{{tag}}Controller` => `zod/PetController`
Default: `${output}/{{tag}}Controller` +::: #### exportAs +::: v-pre Name to be used for the `export * as {{exportAs}} from './` +::: +::: v-pre Type: `string`
Default: `"{{tag}}Schemas"` - +::: ### skipBy Array containing skipBy paramaters to exclude/skip tags/operations/methods/paths.