API routes provide a straightforward solution to build your API with Next.js.
\nAny file inside the folder pages/api is mapped to /api/* and will be treated as an API endpoint instead of a page.
For example, the following API route pages/api/user.js handles a json response:
export default (req, res) => {\n res.statusCode = 200\n res.setHeader('Content-Type', 'application/json')\n res.end(JSON.stringify({ name: 'John Doe' }))\n}\nFor an API route to work, you need to export as default a function (a.k.a request handler), which then receives the following parameters:
\nreq: An instance of http.IncomingMessage, plus some pre-built middlewares you can see hereres: An instance of http.ServerResponse, plus some helper functions you can see hereTo handle different HTTP methods in an API route, you can use req.method in your request handler, like so:
export default (req, res) => {\n if (req.method === 'POST') {\n // Process a POST request\n } else {\n // Handle any other HTTP method\n }\n}\nTo fetch API endpoints, take a look into any of the examples at the start of this section.
\n\n\nAPI Routes do not specify CORS headers, meaning they are same-origin only by default. You can customize such behavior by wrapping the request handler with the cors middleware.
\n
\n\nAPI Routes do not increase your client-side bundle size. They are server-side only bundles.
\n
For more information on what to do next, we recommend the following sections:
\n\n\n"},"__N_SSG":true}