服务器
服务器 API
了解如何为您的 Nuxt 项目生成 API 文档。
目前这处于实验阶段,将来可能会发生变化。
入门
NuxtHub 使用 Nitro 的 OpenAPI 生成来访问您的 Nuxt 项目的 API。
要启用 API,您需要添加启用 Nitro 的实验性 openAPI
功能。您可以通过在您的 nuxt.config.ts
文件中添加 nitro.experimental.openAPI
属性来实现。
nuxt.config.ts
export default defineNuxtConfig({
nitro: {
experimental: {
openAPI: true
}
}
})
部署项目后,NuxtHub 管理员将使用 Scalar 展示您的 API 文档。
Nuxt 开发工具
在开发过程中,您可以使用 Nuxt 开发工具通过 服务器路由
选项卡访问您的 API 路由。
它列出了您项目中的所有 API 路由,并提供了一个游乐场来发送和测试您的端点。
查看 Nuxt 开发工具 文档以了解更多信息。