Setup
Configuration
Learn how to configure NuxtOpenFetch
nuxt.config.ts
export default defineNuxtConfig({
modules: ['nuxt-open-fetch'],
openFetch: {
clients: {}
}
})
| Key | Type | Default | Description |
|---|---|---|---|
openAPITS | OpenAPITSOptions | OpenAPI TS options | |
addPlugin | boolean | true | If enable default plugin to create fetch clients |
| Clients | |||
clients.[client] | OpenFetchClientOptions | Client options | |
clients.[client].baseURL | string | Base URL for the request. | |
clients.[client].headers | HeadersInit | Request headers. | |
clients.[client].query | SearchParameters | Adds query search params to URL | |
clients.[client].schema | OpenAPI3Schema | Local or remote schema file (YAML or JSON) |
Runtime configuration
All options, except schema, are automatically copied to the runtime config.
You can access and modify these options at runtime using
useRuntimeConfig().This is particularly useful for overriding settings with environment variables. For example:
.env
NUXT_PUBLIC_OPEN_FETCH_PETS_BASE_URL=https://petstore3.swagger.io/api/v3/