Nuxt/docs/content/3.server/2.api.md

44 lines
838 B
Markdown
Raw Normal View History

---
navigation:
title: API
---
2021-04-20 12:16:09 +00:00
# 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()`).
## Examples
### Hello world
```js [server/api/hello.ts]
export default (req, res) => 'Hello World'
```
See result on http://localhost:3000/api/hello
### Async function
```js [server/api/async.ts]
export default async (req, res) => {
await someAsyncFunction()
return {
someData: true
}
}
```
**Example:** Using Node.js style
```ts [server/api/node.ts]
import type { IncomingMessage, ServerResponse } from 'http'
export default async (req: IncomingMessage, res: ServerResponse) => {
res.statusCode = 200
res.end('Works!')
}
```