开放 API 文档

入门

NuxtHub 使用 Nitro 的 OpenAPI 生成来访问您 Nuxt 项目的 API。

要启用 API，您需要添加启用 Nitro 的实验性 openAPI 功能。您可以在您的 nuxt.config.ts 文件中添加 nitro.experimental.openAPI 属性来实现这一点。

export default defineNuxtConfig({
  nitro: {
    experimental: {
      openAPI: true
    }
  }
})

部署项目后，NuxtHub 管理员将使用 Scalar 展示您的 API 文档。

Nuxt DevTools

在开发中，您可以使用 Nuxt DevTools 访问您的 API 路由。 使用 服务器路由 选项卡。

它列出了您项目中的所有 API 路由，并提供了一个游乐场来发送和测试您的端点。

查看 Nuxt DevTools 文档以获取更多信息。