https://github.com/devjiwonchoi/create-next-api
https://github.com/devjiwonchoi/create-next-api
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devjiwonchoi/create-next-api
- Owner: devjiwonchoi
- Created: 2024-07-21T17:29:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T07:48:59.000Z (almost 2 years ago)
- Last Synced: 2025-07-10T00:47:05.095Z (12 months ago)
- Language: TypeScript
- Homepage: https://create-next-api.vercel.app
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/route.ts`. The page auto-updates as you edit the file.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
## API Routes
This directory contains example API routes for the headless API app.
Here's an overview of the available routes:
1. Root Route (`/`):
- Provides a list of available API endpoints.
- Useful for discovering what the API offers.
2. Pokemon Routes:
- List all Pokemon (`/pokemon`): Get an overview of available Pokemon.
- Filter Pokemon by type (`/pokemon?type=grass`): Find Pokemon of a specific element.
- Get a specific Pokemon (`/pokemon/25`): Fetch details about a particular Pokemon by ID.
3. HTTP Methods Route (`/methods`):
- Information about supported HTTP methods.
- Great for learning about various types of API requests.
4. Specific HTTP Method Routes (`/methods/[method]`):
- Demonstrates different HTTP methods (GET, POST, PUT, DELETE, PATCH).
- Helps understand how different types of API requests behave.
5. Not Found Route:
- Handles requests to undefined routes.
- Returns a "Not Found" response for non-existent endpoints.
Each route is wrapped with middleware that adds:
- Request logging for monitoring and debugging.
- Origin checking for security.
- Authentication placeholders for future expansion.
To explore these routes:
1. Start the development server.
2. Open your browser and navigate to `http://localhost:3000/[route]`.
3. Examine the responses to understand how each route works.
For more details on the implementation, check the corresponding files in the `app` directory.