From d9ee37a31e4400dd148027c170d870d10bbe35ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alper=20Do=C4=9Fan?= Date: Sat, 15 Jul 2023 18:35:53 +0300 Subject: [PATCH] docs: add server middleware and plugins explanation --- docs/1.getting-started/6.server-directory.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/1.getting-started/6.server-directory.md b/docs/1.getting-started/6.server-directory.md index d1010ada00..b415a6b29e 100644 --- a/docs/1.getting-started/6.server-directory.md +++ b/docs/1.getting-started/6.server-directory.md @@ -4,7 +4,7 @@ description: Using server directory to create middlewares, plugins and API easil # Server Directory -Nuxt scans files and create middlewares, plugins and API routes to create features to use inside components or pages. +Nuxt scans files under server directory to create middlewares, plugins and API routes to create features to use inside components or pages. Each file under these folders must return a function defined with `defineEventHandler()`. @@ -32,3 +32,21 @@ Server route file will automatically match with `GET` method and it can be chang Routes may accept parameters, body and query parameters to get some values. :ReadMore{link="/docs/guide/directory-structure/server#matching-route-parameters"} + +## Server Middleware + +Nuxt will read anything under `~/server/middleware` folder and create middlewares for you to tweak request information. + +```ts [server/middleware/log.ts] +export default defineEventHandler((event) => { + event.context.auth = { user: 123 } +}) +``` + +:ReadMore{link="/docs/guide/directory-structure/server#server-middleware"} + +## Server Plugins + +Any files under `~/server/plugins` folder will be registered as Nitro Plugin for changing [Nitro](https://nitro.unjs.io/)'s behavior. + +:ReadMore{link="/docs/guide/directory-structure/server#server-plugins"}