27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
---
|
|
description: API Routes include a set of Express.js-like methods for the response to help you creating new API endpoints. Learn how it works here.
|
|
---
|
|
|
|
# Response Helpers
|
|
|
|
<details open>
|
|
<summary><b>Examples</b></summary>
|
|
<ul>
|
|
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/api-routes">Basic API Routes</a></li>
|
|
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/api-routes-rest">API Routes with REST</a></li>
|
|
</ul>
|
|
</details>
|
|
|
|
The response (`res`) includes a set of Express.js-like methods to improve the developer experience and increase the speed of creating new API endpoints, take a look at the following example:
|
|
|
|
```js
|
|
export default (req, res) => {
|
|
res.status(200).json({ name: 'Next.js' })
|
|
}
|
|
```
|
|
|
|
The included helpers are:
|
|
|
|
- `res.status(code)` - A function to set the status code. `code` must be a valid [HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)
|
|
- `res.json(json)` - Sends a JSON response. `json` must be a valid JSON object
|
|
- `res.send(body)` - Sends the HTTP response. `body` can be a `string`, an `object` or a `Buffer`
|