Enable API Docs

Enable the helper

export default defineNuxtConfig({
  experimental: { openAPI: true },
});

Choose the docs UI

Pick either Scalar or Swagger for your public docs.

openAPI: {
  ui: {
    scalar: { route: "/_docs", theme: "purple" },
    swagger: { route: "/_docs/swagger" },
  },
}

Share the hosted URLs

Nitro serves these endpoints automatically:

• Scalar: http://localhost:3000/_docs
• Swagger UI: http://localhost:3000/_docs/swagger
• Raw OpenAPI: http://localhost:3000/_docs/openapi.json