Vue OpenAPI Query Documentation
    Preparing search index...

    Interface OpenApiConfig<Ops>

    Configuration object for initializing the OpenAPI client.

    This interface defines the required configuration to set up a type-safe OpenAPI client with Vue Query integration. It requires both the operations metadata (typically generated from your OpenAPI specification) and an Axios instance for making HTTP requests.

    The axios request configuration type (defaults to AxiosRequestConfig)

    import { OpenApiConfig } from '@qualisero/openapi-endpoint'
    import { openApiOperations, type OpenApiOperations } from './generated/api-operations'
    import axios from 'axios'

    // Basic usage with default axios config
    const config: OpenApiConfig<OpenApiOperations> = {
      operations: openApiOperations,
      axios: axios.create({
        baseURL: 'https://api.example.com',
        headers: { 'Authorization': 'Bearer token' }
      }),
      queryClient: customQueryClient // optional
    }

    // With custom axios config type (for module augmentation)
    const configWithCustomAxios: OpenApiConfig<OpenApiOperations, MyCustomAxiosRequestConfig> = {
      operations: openApiOperations,
      axios: customAxiosInstance
    }
    interface OpenApiConfig<Ops extends Operations<Ops>> {
        operations: Ops;
        axios: AxiosInstance;
        queryClient?: QueryClientLike;
    }

    Type Parameters

    • Ops extends Operations<Ops>

      The operations type, typically generated from your OpenAPI specification

    Index

    Properties

    operations axios queryClient?

    Properties

    operations: Ops

    The operations metadata object, typically generated from your OpenAPI specification. This contains type information and HTTP method details for each API endpoint.

    axios: AxiosInstance

    Axios instance for making HTTP requests. Configure this with your base URL, authentication, and any global request/response interceptors.

    queryClient?: QueryClientLike

    Optional TanStack Query client instance. If not provided, a default QueryClient with sensible defaults will be used.

    Note: This accepts any QueryClient-like object that implements the required methods, ensuring compatibility across different versions of @tanstack/vue-query.

    Settings

    Member Visibility

    On This Page

    Properties