UNPKG

4.3 kB Markdown View Raw
1---
2title: Resource Routes
3---
4
5# Resource Routes
6
7[MODES: framework, data]
8
9<br/>
10<br/>
11
12When server rendering, routes can serve "resources" instead of rendering components, like images, PDFs, JSON payloads, webhooks, etc.
13
14## Defining a Resource Route
15
16A route becomes a resource route by convention when its module exports a loader or action but does not export a default component.
17
18Consider a route that serves a PDF instead of UI:
19
20```ts
21route("/reports/pdf/:id", "pdf-report.ts");
22```
23
24```tsx filename=pdf-report.ts
25import type { Route } from "./+types/pdf-report";
26
27export async function loader({ params }: Route.LoaderArgs) {
28 const report = await getReport(params.id);
29 const pdf = await generateReportPDF(report);
30 return new Response(pdf, {
31 status: 200,
32 headers: {
33 "Content-Type": "application/pdf",
34 },
35 });
36}
37```
38
39Note there is no default export. That makes this route a resource route.
40
41## Linking to Resource Routes
42
43When linking to resource routes, use `<a>` or `<Link reloadDocument>`, otherwise React Router will attempt to use client side routing and fetching the payload (you'll get a helpful error message if you make this mistake).
44
45```tsx
46<Link reloadDocument to="/reports/pdf/123">
47 View as PDF
48</Link>
49```
50
51## Handling different request methods
52
53GET requests are handled by the `loader`, while POST, PUT, PATCH, and DELETE are handled by the `action`:
54
55```tsx
56import type { Route } from "./+types/resource";
57
58export function loader(_: Route.LoaderArgs) {
59 return Response.json({ message: "I handle GET" });
60}
61
62export function action(_: Route.ActionArgs) {
63 return Response.json({
64 message: "I handle everything else",
65 });
66}
67```
68
69## Return Types
70
71Resource Routes are flexible when it comes to the return type - you can return [`Response`][Response] instances or [`data()`][data] objects. A good general rule of thumb when deciding which type to use is:
72
73- If you're using resource routes intended for external consumption, return `Response` instances
74 - Keeps the resulting response encoding explicit in your code rather than having to wonder how React Router might convert `data() -> Response` under the hood
75- If you're accessing resource routes from [fetchers][fetcher] or [`<Form>`][form] submissions, return `data()`
76 - Keeps things consistent with the loaders/actions in your UI routes
77 - Allows you to stream promises down to your UI through `data()`/[`Await`][await]
78
79## Error Handling
80
81Throwing an `Error` from Resource route (or anything other than a `Response`/`data()`) will trigger [`handleError`][handleError] and result in a 500 HTTP Response:
82
83```tsx
84export function action() {
85 let db = await getDb();
86 if (!db) {
87 // Fatal error - return a 500 response and trigger `handleError`
88 throw new Error("Could not connect to DB");
89 }
90 // ...
91}
92```
93
94If a resource route generates a `Response` (via `new Response()` or `data()`), it is considered a successful execution and will not trigger `handleError` because the API has successfully produced a Response for the HTTP request. This applies to thrown responses as well as returned responses with a 4xx/5xx status code. This behavior aligns with `fetch()` which does not return a rejected promise on 4xx/5xx Responses.
95
96```tsx
97export function action() {
98 // Non-fatal error - don't trigger `handleError`:
99 throw new Response(
100 { error: "Unauthorized" },
101 { status: 401 },
102 );
103
104 // These 3 are equivalent to the above
105 return new Response(
106 { error: "Unauthorized" },
107 { status: 401 },
108 );
109
110 throw data({ error: "Unauthorized" }, { status: 401 });
111
112 return data({ error: "Unauthorized" }, { status: 401 });
113}
114```
115
116### Error Boundaries
117
118[Error Boundaries][error-boundary] are only applicable when a resource route is accessed from a UI, such as from a [`fetcher`][fetcher] call or a [`<Form>`][form] submission. If you `throw` from your resource route in these cases, it will bubble to the nearest `ErrorBoundary` in the UI.
119
120[handleError]: ../api/framework-conventions/entry.server.tsx#handleerror
121[data]: ../api/utils/data
122[Response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
123[fetcher]: ../api/hooks/useFetcher
124[form]: ../api/components/Form
125[await]: ../api/components/Await
126[error-boundary]: ../start/framework/route-module#errorboundary