Accept header content negotiation (#90607)

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?
Added a new "Content negotiation" subsection to the Backend For Frontend
(BFF) guide.
Updated the `related` links in the frontmatter of the BFF guide to
include "rewrites".

### Why?
To document how to implement content negotiation using Next.js rewrites
and Route Handlers, specifically for serving different content types
(e.g., Markdown) based on the `Accept` header. This includes explaining
the role of the `Vary: Accept` header for correct caching behavior.

### How?
A new subsection was added to
`docs/01-app/02-guides/backend-for-frontend.mdx`.
The section includes a `next.config.js` rewrite example using `has` to
match the `Accept` header.
A corresponding Route Handler example (`app/docs/md/[...slug]/route.ts`)
demonstrates serving Markdown content.
The documentation explains the `Vary: Accept` header and its
implications for caching.
The `related` links in the frontmatter were updated to point to the
rewrites documentation.

Closes NEXT-
Fixes #

-->

---
[Slack
Thread](https://vercel.slack.com/archives/C07BS1WEYAZ/p1772118031912479?thread_ts=1772118031.912479&cid=C07BS1WEYAZ)

<p><a
href="https://cursor.com/agents/bc-2c93f44d-958d-5c0b-abe0-a2b36aa76f19"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/background-agent?bcId=bc-2c93f44d-958d-5c0b-abe0-a2b36aa76f19"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img
alt="Open in Cursor" width="131" height="28"
src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;</p>

---------

Co-authored-by: Cursor Agent <[email protected]>
Co-authored-by: Joseph <[email protected]>
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
This commit is contained in:
Joseph
2026-02-27 19:31:22 +01:00
committed by GitHub
co-authored by Cursor Agent Joseph vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
parent fe2f1e4405
commit 080e1b3c26
+101 -1
View File
@@ -4,10 +4,11 @@ nav_title: Backend for Frontend
description: Learn how to use Next.js as a backend framework
related:
title: API Reference
description: Learn more about Route Handlers and Proxy
description: Learn more about Route Handlers, Proxy, and Rewrites
links:
- app/api-reference/file-conventions/route
- app/api-reference/file-conventions/proxy
- app/api-reference/config/next-config-js/rewrites
---
Next.js supports the "Backend for Frontend" pattern. This lets you create public endpoints to handle HTTP requests and return any content type—not just HTML. You can also access data sources and perform side effects like updating remote data.
@@ -178,6 +179,105 @@ export async function GET(request) {
Sanitize any input used to generate markup.
### Content negotiation
You can use [rewrites](/docs/app/api-reference/config/next-config-js/rewrites) with header matching to serve different content types from the same URL based on the request's `Accept` header. This is known as [content negotiation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation).
For example, a documentation site might serve HTML pages to browsers and raw Markdown to AI agents from the same `/docs/…` URLs.
**1. Configure a rewrite that matches the `Accept` header:**
```js filename="next.config.js"
module.exports = {
async rewrites() {
return [
{
source: '/docs/:slug*',
destination: '/docs/md/:slug*',
has: [
{
type: 'header',
key: 'accept',
value: '(.*)text/markdown(.*)',
},
],
},
]
},
}
```
When a request to `/docs/getting-started` includes `Accept: text/markdown`, the rewrite routes it to `/docs/md/getting-started`. A Route Handler at that path returns the Markdown response. Clients that do not send `text/markdown` in their `Accept` header continue to receive the normal HTML page.
**2. Create a Route Handler for the Markdown response:**
```ts filename="app/docs/md/[...slug]/route.ts" switcher
import { getDocsMd, generateDocsStaticParams } from '@/lib/docs'
export async function generateStaticParams() {
return generateDocsStaticParams()
}
export async function GET(_: Request, ctx: RouteContext<'/docs/md/[...slug]'>) {
const { slug } = await ctx.params
const mdDoc = await getDocsMd({ slug })
if (mdDoc == null) {
return new Response(null, { status: 404 })
}
return new Response(mdDoc, {
headers: {
'Content-Type': 'text/markdown; charset=utf-8',
Vary: 'Accept',
},
})
}
```
```js filename="app/docs/md/[...slug]/route.js" switcher
import { getDocsMd, generateDocsStaticParams } from '@/lib/docs'
export async function generateStaticParams() {
return generateDocsStaticParams()
}
export async function GET(_, { params }) {
const { slug } = await params
const mdDoc = await getDocsMd({ slug })
if (mdDoc == null) {
return new Response(null, { status: 404 })
}
return new Response(mdDoc, {
headers: {
'Content-Type': 'text/markdown; charset=utf-8',
Vary: 'Accept',
},
})
}
```
The [`Vary: Accept`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary) response header tells caches that the response body depends on the `Accept` request header. Without it, a shared cache could serve a cached Markdown response to a browser (or vice versa). Most hosting providers already include the `Accept` header in their cache key, but setting `Vary` explicitly ensures correct behavior across all CDNs and proxy caches.
`generateStaticParams` lets you pre-render the Markdown variants at build time so they can be served from the edge without hitting the origin server on every request.
**3. Test it with `curl`:**
```bash
# Returns Markdown
curl -H "Accept: text/markdown" https://example.com/docs/getting-started
# Returns the normal HTML page
curl https://example.com/docs/getting-started
```
> **Good to know:**
>
> - The `/docs/md/...` route is still directly accessible without the rewrite. If you want to restrict it to only serve via the rewrite, use [`proxy`](/docs/app/api-reference/file-conventions/proxy) to block direct requests that don't include the expected `Accept` header.
> - For more advanced negotiation logic, you can use [`proxy`](/docs/app/api-reference/file-conventions/proxy) instead of rewrites for more flexibility.
### Consuming request payloads
Use Request [instance methods](https://developer.mozilla.org/en-US/docs/Web/API/Request#instance_methods) like `.json()`, `.formData()`, or `.text()` to access the request body.