264fc01969
* API routes examples and documentation * Update examples/api-routes-micro/README.md Co-Authored-By: Luis Fernando Alvarez D. <luis@zeit.co> * Update examples/api-routes/README.md Co-Authored-By: Luis Fernando Alvarez D. <luis@zeit.co> * Apply suggestions from code review Co-Authored-By: Luis Fernando Alvarez D. <luis@zeit.co> * Update API routes docs * Improve example to reflect dynamic routes * Update readme to reflect API routes changes * Apply suggestions from review
42 lines
1 KiB
Markdown
42 lines
1 KiB
Markdown
# Basic API routes example
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example api-routes api-routes-app
|
|
# or
|
|
yarn create next-app --example api-routes api-routes-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example:
|
|
|
|
```bash
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/api-routes
|
|
cd api-routes
|
|
```
|
|
|
|
Install it and run:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
# or
|
|
yarn
|
|
yarn dev
|
|
```
|
|
|
|
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))
|
|
|
|
```bash
|
|
now
|
|
```
|
|
|
|
## The idea behind the example
|
|
|
|
Next.js ships with [API routes](https://github.com/zeit/next.js#api-routes) 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.
|