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.

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

updated the example of api-routes to utilize the App Router #68771

Merged
merged 11 commits into from
Aug 13, 2024
20 changes: 0 additions & 20 deletions examples/api-routes/package.json

This file was deleted.

17 changes: 0 additions & 17 deletions examples/api-routes/pages/api/people/[id].ts

This file was deleted.

10 changes: 0 additions & 10 deletions examples/api-routes/pages/api/people/index.ts

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Basic API routes example

Next.js ships with [API routes](https://nextjs.org/docs/api-routes/introduction) which provides an easy solution to build your own `API`. This example shows how to create multiple `API` endpoints with serverless functions, which can execute independently.
Next.js ships with [Route Handlers](https://nextjs.org/docs/app/building-your-application/routing/route-handlers) which provides an easy solution to build your own `API`. This example shows how to create multiple `API` endpoints with serverless functions, which can execute independently.

## Deploy your own

Expand Down
20 changes: 20 additions & 0 deletions examples/route-handlers/app/api/people/[id]/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { NextResponse } from "next/server";
import { people } from "../../../../data";
import type { Person, ResponseError } from "../../../../interfaces";

export async function GET(
request: Request,
{ params }: { params: { id: string } },
): Promise<NextResponse<Person | ResponseError>> {
const { id } = params;
const person = people.find((p) => p.id === id);

if (person) {
return NextResponse.json(person);
} else {
return NextResponse.json(
{ message: `User with id: ${id} not found.` },
{ status: 404 },
);
}
}
7 changes: 7 additions & 0 deletions examples/route-handlers/app/api/people/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { NextResponse } from "next/server";
import { people } from "../../../data";
import { Person } from "../../../interfaces";

export async function GET(): Promise<NextResponse<Person[]>> {
return NextResponse.json(people);
}
18 changes: 18 additions & 0 deletions examples/route-handlers/app/layout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import type { Metadata } from "next";

export const metadata: Metadata = {
title: "Home",
description: "Welcome to Next.js",
};

export default function RootLayout({
children,
}: {
children: React.ReactNode;
}) {
return (
<html lang="en">
<body>{children}</body>
</html>
);
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
"use client";
import useSWR from "swr";
import PersonComponent from "../components/Person";
import type { Person } from "../interfaces";
Expand All @@ -6,7 +7,6 @@ const fetcher = (url: string) => fetch(url).then((res) => res.json());

export default function Index() {
const { data, error, isLoading } = useSWR<Person[]>("/api/people", fetcher);

if (error) return <div>Failed to load</div>;
if (isLoading) return <div>Loading...</div>;
if (!data) return null;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { useRouter } from "next/router";
"use client";

import { useParams } from "next/navigation";
import useSWR from "swr";
import type { Person, ResponseError } from "../../interfaces";
import type { Person, ResponseError } from "../../../interfaces";

const fetcher = async (url: string) => {
const res = await fetch(url);
Expand All @@ -13,11 +15,11 @@ const fetcher = async (url: string) => {
};

export default function PersonPage() {
const { query } = useRouter();
const query = useParams();
const { data, error, isLoading, isValidating } = useSWR<
Person,
ResponseError
>(() => (query.id ? `/api/people/${query.id}` : null), fetcher);
>(() => (query?.id ? `/api/people/${query.id}` : null), fetcher);

if (error) return <div>{error.message}</div>;
if (isLoading) return <div>Loading...</div>;
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.
20 changes: 20 additions & 0 deletions examples/route-handlers/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start"
},
"dependencies": {
"next": "latest",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"swr": "^2.2.5"
},
"devDependencies": {
"@types/node": "^22.2.0",
"@types/react": "^18.3.3",
"@types/react-dom": "^18.3.0",
"typescript": "^5.5.4"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,13 @@
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve",
"incremental": true
"incremental": true,
"plugins": [
{
"name": "next"
}
]
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
"exclude": ["node_modules"]
}
Loading