defineApifulConfig

Defines the configuration for all services in the APIful application.

NOTE

For now, this only makes sense with the npx apiful generate command to generate TypeScript definitions from OpenAPI schemas and the OpenAPI extension to build the type-safe API client.

Example

Import the defineApifulConfig function from apiful/config and define a petStore service using the OpenAPI schema from the Swagger Petstore API:

import { defineApifulConfig } from 'apiful/config'

export default defineApifulConfig({
  services: {
    petStore: {
      schema: 'https://petstore3.swagger.io/api/v3/openapi.json',
    },
  },
})

Type Definition

interface ServiceOptions {
  url?: string
  schema?: string | URL | OpenAPI3 | (() => Promise<OpenAPI3>)
  openAPITS?: OpenAPITSOptions
}

interface ApifulConfig {
  services: Record<string, ServiceOptions>
}

declare function defineApifulConfig(config: ApifulConfig): ApifulConfig

NOTE

openapi-typescript provides the OpenAPI3 and OpenAPITSOptions types and serves as the OpenAPI specification to TypeScript definitions generator.