README.md 1.3 KB
Newer Older
L
Lukáš Huvar 已提交
1 2
# Basic API routes example

3 4
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.

5 6 7 8
## Deploy your own

Deploy the example using [ZEIT Now](https://zeit.co/now):

9
[![Deploy with ZEIT Now](https://zeit.co/button)](https://zeit.co/import/project?template=https://github.com/zeit/next.js/tree/canary/examples/api-routes)
10

L
Lukáš Huvar 已提交
11 12 13 14
## How to use

### Using `create-next-app`

15
Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
L
Lukáš Huvar 已提交
16 17

```bash
18
npm init next-app --example api-routes api-routes-app
L
Lukáš Huvar 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
# 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
```

42
Deploy it to the cloud with [ZEIT Now](https://zeit.co/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).