Unverified Commit 6e6533c9 authored by Eric Bidelman's avatar Eric Bidelman Committed by GitHub

Update 10-route-handlers.mdx (#59443)

According to
https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config#dynamic,
the default for dynamic is "auto".

<!-- 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

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### 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?

### Why?

### How?

Closes NEXT-
Fixes #

-->
parent 4a6d3675
...@@ -25,12 +25,12 @@ Route Handlers allow you to create custom request handlers for a given route usi ...@@ -25,12 +25,12 @@ Route Handlers allow you to create custom request handlers for a given route usi
Route Handlers are defined in a [`route.js|ts` file](/docs/app/api-reference/file-conventions/route) inside the `app` directory: Route Handlers are defined in a [`route.js|ts` file](/docs/app/api-reference/file-conventions/route) inside the `app` directory:
```ts filename="app/api/route.ts" switcher ```ts filename="app/api/route.ts" switcher
export const dynamic = 'force-dynamic' // defaults to force-static export const dynamic = 'force-dynamic' // defaults to auto
export async function GET(request: Request) {} export async function GET(request: Request) {}
``` ```
```js filename="app/api/route.js" switcher ```js filename="app/api/route.js" switcher
export const dynamic = 'force-dynamic' // defaults to force-static export const dynamic = 'force-dynamic' // defaults to auto
export async function GET(request) {} export async function GET(request) {}
``` ```
...@@ -575,7 +575,7 @@ Since `formData` data are all strings, you may want to use [`zod-form-data`](htt ...@@ -575,7 +575,7 @@ Since `formData` data are all strings, you may want to use [`zod-form-data`](htt
You can set CORS headers on a `Response` using the standard Web API methods: You can set CORS headers on a `Response` using the standard Web API methods:
```ts filename="app/api/route.ts" switcher ```ts filename="app/api/route.ts" switcher
export const dynamic = 'force-dynamic' // defaults to force-static export const dynamic = 'force-dynamic' // defaults to auto
export async function GET(request: Request) { export async function GET(request: Request) {
return new Response('Hello, Next.js!', { return new Response('Hello, Next.js!', {
...@@ -590,7 +590,7 @@ export async function GET(request: Request) { ...@@ -590,7 +590,7 @@ export async function GET(request: Request) {
``` ```
```js filename="app/api/route.js" switcher ```js filename="app/api/route.js" switcher
export const dynamic = 'force-dynamic' // defaults to force-static export const dynamic = 'force-dynamic' // defaults to auto
export async function GET(request) { export async function GET(request) {
return new Response('Hello, Next.js!', { return new Response('Hello, Next.js!', {
...@@ -619,7 +619,7 @@ export const runtime = 'edge' // 'nodejs' is the default ...@@ -619,7 +619,7 @@ export const runtime = 'edge' // 'nodejs' is the default
You can use Route Handlers to return non-UI content. Note that [`sitemap.xml`](/docs/app/api-reference/file-conventions/metadata/sitemap#generate-a-sitemap), [`robots.txt`](/docs/app/api-reference/file-conventions/metadata/robots#generate-a-robots-file), [`app icons`](/docs/app/api-reference/file-conventions/metadata/app-icons#generate-icons-using-code-js-ts-tsx), and [open graph images](/docs/app/api-reference/file-conventions/metadata/opengraph-image) all have built-in support. You can use Route Handlers to return non-UI content. Note that [`sitemap.xml`](/docs/app/api-reference/file-conventions/metadata/sitemap#generate-a-sitemap), [`robots.txt`](/docs/app/api-reference/file-conventions/metadata/robots#generate-a-robots-file), [`app icons`](/docs/app/api-reference/file-conventions/metadata/app-icons#generate-icons-using-code-js-ts-tsx), and [open graph images](/docs/app/api-reference/file-conventions/metadata/opengraph-image) all have built-in support.
```ts filename="app/rss.xml/route.ts" switcher ```ts filename="app/rss.xml/route.ts" switcher
export const dynamic = 'force-dynamic' // defaults to force-static export const dynamic = 'force-dynamic' // defaults to auto
export async function GET() { export async function GET() {
return new Response(`<?xml version="1.0" encoding="UTF-8" ?> return new Response(`<?xml version="1.0" encoding="UTF-8" ?>
...@@ -636,7 +636,7 @@ export async function GET() { ...@@ -636,7 +636,7 @@ export async function GET() {
``` ```
```js filename="app/rss.xml/route.js" switcher ```js filename="app/rss.xml/route.js" switcher
export const dynamic = 'force-dynamic' // defaults to force-static export const dynamic = 'force-dynamic' // defaults to auto
export async function GET() { export async function GET() {
return new Response(`<?xml version="1.0" encoding="UTF-8" ?> return new Response(`<?xml version="1.0" encoding="UTF-8" ?>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment