Nuxt3【服务器】server 详解
创始人
2024-09-26 01:48:23
0

server 文件夹中的内容,会被自动注册为API和服务器处理程序。

服务器 API

对应路径 server/api

server/api/hello.ts

export default defineEventHandler((event) => {   return {     hello: 'world'   } }) 

页面中使用

   

动态参数 []

server/api/hello/[name].ts

export default defineEventHandler((event) => {   const name = getRouterParam(event, 'name')    return `Hello, ${name}!` }) 

[…slug].ts 全匹配

捕获所有API,并通过 event.context.params.slug 访问匹配的内容

export default defineEventHandler((event) => {   // 访问 /api/bar/baz ,则 event.context.params.slug 获取路由段:'bar/baz'   return `Default foo handler` }) 

定义HTTP方法

文件名中使用.get、.post、.put、.delete等后缀来定义HTTP方法

server/api/test.get.ts

export default defineEventHandler(() => 'Test get handler') 

GET方法请求 /test 会返回Test get handler

获取 GET 方法中的参数 getQuery

如查询 /api/query?foo=bar&baz=qux

server/api/query.get.ts

export default defineEventHandler((event) => {   const query = getQuery(event)    return { a: query.foo, b: query.baz } }) 

获取 POST 中的请求体 readBody

server/api/submit.post.ts

export default defineEventHandler(async (event) => {   const body = await readBody(event)   return { body } }) 

获取运行时配置 useRuntimeConfig

export default defineEventHandler(async (event) => {   const config = useRuntimeConfig(event)    const repo = await $fetch('https://api.github.com/repos/nuxt/nuxt', {     headers: {       Authorization: `token ${config.githubToken}`     }   })    return repo }) 

配置信息在 nuxt.config.ts 中定义

export default defineNuxtConfig({   runtimeConfig: {     githubToken: ''   } }) 

获取和设置 Cookie 信息

方式一:parseCookies

export default defineEventHandler((event) => {   const cookies = parseCookies(event)    return { cookies } }) 

**方式二:getCookie 和 setCookie **

来自 h3 包

export default defineEventHandler(event => {   // 读取counter cookie   let counter = getCookie(event, 'counter') || 0     // 将counter cookie增加1   setCookie(event, 'counter', ++counter)    // 发送JSON响应   return { counter } }) 

错误处理

  • 没有抛出错误,将返回状态码200 OK
  • 任何未捕获的错误都将返回500 Internal Server Error
  • 返回其他错误代码,请使用createError抛出异常

server/api/validation/[id].ts

export default defineEventHandler((event) => {   const id = parseInt(event.context.params.id) as number    if (!Number.isInteger(id)) {     throw createError({       statusCode: 400,       statusMessage: 'ID should be an integer',     })   }   return 'All good' }) 

状态码

返回其他状态码,请使用setResponseStatus实用程序。

server/api/validation/[id].ts

export default defineEventHandler((event) => {   // 返回202 Accepted   setResponseStatus(event, 202) }) 

重定向 sendRedirect

export default defineEventHandler(async (event) => {   await sendRedirect(event, '/path/redirect/to', 302) })  

服务器路由

对应路径 server/routes

server/routes/hello.ts

export default defineEventHandler(() => 'Hello World!') 

即定义了 /hello 路由

服务器中间件

对应路径 server/middleware

中间件处理程序将在任何其他服务器路由之前在每个请求上运行,以添加或检查标头、记录请求或扩展事件的请求对象。

  • 中间件处理程序不应返回任何内容(也不应关闭或响应请求),只能检查或扩展请求上下文或抛出错误。

server/middleware/log.ts

export default defineEventHandler((event) => {   console.log('New request: ' + getRequestURL(event)) }) 

server/middleware/auth.ts

export default defineEventHandler((event) => {   event.context.auth = { user: 123 } }) 

服务器插件

对应路径 server/plugins

它们会被注册为Nitro插件。这允许扩展Nitro的运行时行为并钩入生命周期事件。

server/plugins/nitroPlugin.ts

export default defineNitroPlugin((nitroApp) => {   console.log('Nitro plugin', nitroApp) }) 

服务器工具

对应路径 server/utils

可以添加更多的自定义辅助函数

server/utils/handler.ts

import type { EventHandler, EventHandlerRequest } from 'h3'  export const defineWrappedResponseHandler =  (   handler: EventHandler ): EventHandler =>   defineEventHandler(async event => {     try {       // 在路由处理程序之前执行某些操作       const response = await handler(event)       // 在路由处理程序之后执行某些操作       return { response }     } catch (err) {       // 错误处理       return { err }     }   }) 

服务器类型

对应路径 server/tsconfig.json
Nuxt >= 3.5 版本中可用

下方代码可提高IDE中对来自’nitro’和’vue’的自动导入的清晰度
server/tsconfig.json

{   "extends": "../.nuxt/tsconfig.server.json" } 

服务器类型

对应路径 server/tsconfig.json

相关内容

热门资讯

正版授权“在哪里买扎金花房卡哪... 新超圣是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来享...
终于找到“如何购买金花房卡普及... 九酷大厅是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
正版授权“扎金花链接如何开房卡... 新二号是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来享...
一分钟推荐“微信开金花群房卡到... 新众乐是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来享...
一分钟推荐“微信金花房卡怎么搞... 新九九是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来享...
一分钟了解“微信斗牛房卡专卖店... 微信斗牛是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
秒懂教程“金花建房软件哪个好/... 人皇大厅是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
ia实测“扎金花房卡链接在哪弄... 悠悠互娱是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
魔宠剑侠安卓系统要求,解锁系统... 你有没有听说最近那款超火的魔宠剑侠游戏?没错,就是那个让无数玩家沉迷其中的魔宠剑侠!不过,你知道吗?...
秒懂教程“微信建房玩斗牛房卡怎... 斗牛是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来享受...
正版授权“牛牛房卡卖家联系方式... 新毛豆互娱是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡...
安卓系统有那些文件管理,安卓系... 你有没有发现,安卓系统里的文件管理就像是一个神秘的宝库,里面藏着各种各样的宝贝?今天,就让我带你一探...
终于找到“微信牛牛房卡哪里买的... 人海大厅是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
一分钟了解“微信群发的链接金花... 冷酷大厅是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
一分钟了解“金花房卡从哪里购买... 九酷大厅是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
安卓系统更新相册没了,原因及解... 最近我的安卓手机更新了系统,结果相册里所有的照片都不见了!这可真是让我头疼不已。你知道的,手机相册对...
ia实测“怎样创建微信金花链接... 起点大厅是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
秒懂教程“金花链接房卡如何充值... 新超圣是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来享...
给大家讲解“微信斗牛房卡怎么买... 微信斗牛是一款非常受欢迎的棋牌游戏,咨询房/卡添加微信:15984933许多玩家在游戏中会购买房卡来...
安卓系统如何变成ios系统软件... 你有没有想过,你的安卓手机里那些熟悉的软件,竟然可以摇身一变,成为iOS系统上的应用?没错,就是那个...