mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-25 15:15:19 +00:00
parent
e2f5a3c9b0
commit
9164179b50
@ -1 +1,36 @@
|
||||
# API Routes
|
||||
|
||||
Nuxt will automatically read in any files in the `~/server/api` directory to create API endpoints.
|
||||
|
||||
Each file should export a default function that handles api requests. It can return a promise or JSON data directly or use `res.end()`. API routes are powered by [h3](https://github.com/unjs/h3).
|
||||
|
||||
**Example:** Hello world
|
||||
|
||||
```js [server/api/hello.ts]
|
||||
export default async (req, res) => 'Hello World'
|
||||
```
|
||||
|
||||
See result on http://localhost:3000/api/hello
|
||||
|
||||
**Example:** An async function
|
||||
|
||||
```js [server/api/async.ts]
|
||||
import express from 'express'
|
||||
|
||||
export default async (req, res) => {
|
||||
await someAsyncFunction()
|
||||
|
||||
return {
|
||||
someData: true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Example:** Using NodeJS style
|
||||
|
||||
```js [server/api/node.ts]
|
||||
export default async (req, res) => {
|
||||
res.statusCode = 200
|
||||
res.end('Works!')
|
||||
}
|
||||
```
|
||||
|
@ -1 +1,11 @@
|
||||
# Server Middleware
|
||||
|
||||
Nuxt will automatically read in any files in the `~/server/middleware` to create server middleware for your project. (These files will be run on every request, unliked [API routes](./api) that are mapped to their own routes.)
|
||||
|
||||
Each file should export a default function that will handle a request.
|
||||
|
||||
```js
|
||||
export default async (req, res) => {
|
||||
req.someValue = true
|
||||
}
|
||||
```
|
||||
|
@ -1 +0,0 @@
|
||||
# Storage
|
@ -1 +0,0 @@
|
||||
# Nitro (advanced)
|
Loading…
Reference in New Issue
Block a user