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

相关内容

热门资讯

安卓系统为什么不封闭,揭秘安卓... 你有没有想过,为什么安卓系统那么开放,却不像苹果iOS那样封闭呢?这背后可是有着不少有趣的故事和原因...
安卓系统更新包多大,解析不同版... 你有没有发现,每次安卓系统更新,手机里都会多出那么几个G的文件?这可真是让人好奇,安卓系统更新包究竟...
安卓手机安装双系统吗,安卓手机... 你有没有想过,你的安卓手机是不是也能像电脑一样,装上两个系统,一个用来工作,一个用来娱乐?没错,这就...
oppo会升级安卓系统,畅享最... 你知道吗?最近有个大消息在手机圈里炸开了锅,那就是OPPO要升级安卓系统啦!这可不是什么小打小闹的更...
安卓系统上安装windows,... 你有没有想过,在安卓手机上安装Windows系统?听起来是不是有点不可思议?但你知道吗,这竟然是可能...
安卓系统怎么进运行框,安卓系统... 你有没有想过,你的安卓手机里有一个超级实用的功能,那就是运行框!它就像是一个小助手,帮你快速找到正在...
安卓系统电视无图像设置,安卓电... 你家的安卓系统电视突然没图像了?别急,让我来给你支个招,让你轻松解决这个问题!一、检查电源和连接线首...
安卓机建议升级系统吗,提升性能 你有没有发现,你的安卓手机最近有点儿慢吞吞的?是不是在犹豫要不要升级系统呢?别急,让我来给你好好分析...
升级不了安卓系统升级,探寻升级... 你有没有遇到过这种情况?手机里的安卓系统突然告诉你,它需要升级,但你左等右等,就是升不上去。这可真是...
备用安卓系统手机推荐,盘点热门... 你有没有想过,如果你的手机突然罢工了,你会怎么办?别担心,今天我就要给你安利几款备用安卓系统手机,让...
旧安卓系统ipad无法更新系统... 你有没有遇到过这种情况?你的旧安卓系统iPad突然告诉你,它无法更新系统了!是不是瞬间感觉心里有点小...
运行安卓6系统命令大全,全面掌... 你有没有想过,你的安卓手机里隐藏着无数强大的功能,只等着你去发现和探索呢?今天,就让我带你走进安卓6...
安卓系统简笔画教程下载,轻松绘... 你有没有想过,用简单的线条就能把复杂的安卓系统画出来?没错,就是那种一看就懂,一画就上手的感觉!今天...
华为如何鸿蒙转安卓系统,轻松实... 你知道吗?最近华为的大动作可是让整个科技圈都沸腾了!他们竟然把鸿蒙系统转到了安卓系统上,这可真是让人...
安卓10系统的问题,安卓10系... 你有没有发现,自从你的手机升级到安卓10系统后,好像有点不对劲呢?别急,让我来给你细细道来,看看安卓...
安卓系统苹果搞笑视频,苹果搞笑... 你知道吗?在互联网的世界里,搞笑视频可是个永恒的热门话题。尤其是那些结合了安卓系统和苹果手机的搞笑片...
卡片机改造安卓系统,探索改造之... 你有没有想过,那些曾经陪伴我们记录美好时光的卡片机,现在竟然也能焕发第二春呢?没错,就是那些小巧便携...
装安卓系统倒车出不来,智能科技... 你有没有遇到过这样的事情:手机装了个安卓系统,结果倒车的时候出不来啦?这可不是闹着玩的,简直让人抓狂...
定制安卓系统哪家好点儿,哪家服... 你有没有想过,手机系统就像是个人的衣服,每个人都需要找到最适合自己的那一款?今天,咱们就来聊聊定制安...
台电用回安卓系统吗,开启智能新... 最近有个话题在科技圈里炒得挺热的,那就是台电是不是要用回安卓系统了?你有没有想过,这个小小的决定背后...