server 文件夹中的内容,会被自动注册为API和服务器处理程序。
服务器 API
对应路径 server/api
server/api/hello.ts
页面中使用
动态参数 []
server/api/hello/[name].ts
[…slug].ts 全匹配
捕获所有API,并通过 event.context.params.slug 访问匹配的内容
定义HTTP方法
文件名中使用.get、.post、.put、.delete等后缀来定义HTTP方法
server/api/test.get.ts
GET方法请求 /test 会返回Test get handler
获取 GET 方法中的参数 getQuery
如查询 /api/query?foo=bar&baz=qux
server/api/query.get.ts
获取 POST 中的请求体 readBody
server/api/submit.post.ts
获取运行时配置 useRuntimeConfig
配置信息在 nuxt.config.ts 中定义
获取 Cookie 信息 parseCookies
错误处理
- 没有抛出错误,将返回状态码200 OK
- 任何未捕获的错误都将返回500 Internal Server Error
- 返回其他错误代码,请使用createError抛出异常
server/api/validation/[id].ts
状态码
返回其他状态码,请使用setResponseStatus实用程序。
server/api/validation/[id].ts
重定向 sendRedirect
服务器路由
对应路径 server/routes
server/routes/hello.ts
即定义了 /hello 路由
服务器中间件
对应路径 server/middleware
中间件处理程序将在任何其他服务器路由之前在每个请求上运行,以添加或检查标头、记录请求或扩展事件的请求对象。
- 中间件处理程序不应返回任何内容(也不应关闭或响应请求),只能检查或扩展请求上下文或抛出错误。
server/middleware/log.ts
server/middleware/auth.ts
服务器插件
对应路径 server/plugins
它们会被注册为Nitro插件。这允许扩展Nitro的运行时行为并钩入生命周期事件。
server/plugins/nitroPlugin.ts
服务器工具
对应路径 server/utils
可以添加更多的自定义辅助函数
server/utils/handler.ts
服务器类型
对应路径 server/tsconfig.json
Nuxt >= 3.5 版本中可用
下方代码可提高IDE中对来自’nitro’和’vue’的自动导入的清晰度
server/tsconfig.json
服务器类型
对应路径 server/tsconfig.json