Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add pageExtensions usage note in API Routes #35918

Merged
merged 3 commits into from
May 22, 2022
Merged

docs: Add pageExtensions usage note in API Routes #35918

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f5a948
docs: Add pageExtensions usage note in API Routes
menosprezzi Apr 5, 2022
64ab874
Merge branch 'canary' into patch-1
ijjk May 22, 2022
f1b0124
Apply suggestions from code review
ijjk May 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api-routes/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ export default function handler(req, res) {
}
```

> **Note**: API Routes will be affected by [`pageExtensions` configuration](/docs/api-reference/next.config.js/custom-page-extensions.md) in `next.config.js`.

For an API route to work, you need to export a function as default (a.k.a **request handler**), which then receives the following parameters:

- `req`: An instance of [http.IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage), plus some [pre-built middlewares](/docs/api-routes/api-middlewares.md)
Expand Down