What the difference between baseUrl and schema? And some questions...

[prpanto]

I dont understand the difference between baseUrl and schema... I have an openapi backend and the configs on nuxt.config will be like this? Schema is optional? The clients.[name] is what ever I want? I need to have openapi folder by default? Can I use the use[Client] with useAsyncData or vue query? Any simple example to understand how to use this module?

openFetch: {
  clients: {
    api: {
      baseURL: "localhost:8000",
      schema: "localhost:8000/openapi.json",
    }
  }
}

[anntnzrb]

• baseURL = where API requests go at runtime (your actual backend URL)
• schema = where to get the OpenAPI spec file for generating types (build-time only)

They're completely different purposes. baseURL is runtime config, schema is dev/build-time.

For your setup:

openFetch: {
  clients: {
    api: {
      baseURL: 'http://localhost:8000', // actual API endpoint
      schema: 'http://localhost:8000/openapi.json' // where to fetch the spec
    }
  }
}

To your other questions:

• clients.[name] — yeah, name it whatever you want (api, backend, myService, etc.)
• schema optional? — kinda. If omitted, it looks for openapi/[clientName]/openapi.yaml by default
• openapi folder needed? — only if you don't specify schema explicitly
• useAsyncData / vue-query? — the generated use[Client] composables are wrappers around useFetch, so they already handle async. You can use them directly or wrap in vue-query if you prefer that API

[Norbiros]

And if you are looking for quick & simple examples, check out the documentation or playground/ directory.