sample-hapi-rest-api

KO | EN

gitlite — search

#python #typescript #llm #android #machine-learning #rust #linux #macos #windows #awesome #vue #pytorch #mcp #openai

sample-hapi-rest-api

(★ 194)

A sample structure for building a REST API on top of hapi.js framework

파일 탐색기

최종 버전 다운로드 (.zip)

- - constants.js
- - reply-helper.js
  - task.js
- - task.js
  - user.js
- - basic-auth.js
  - db.js
- - index.js
  - task.js
  - user.js
- - index.js
  - task.js
- - mixins.js
  - pagination-links.js
  - walk-dir.js
- - task.js
- - index.js
  - mixins.js
  - pagination-links.js
  - task.js
- mocha.opts
.gitignore
database.json
database.sh
Gruntfile.js
index.js
LICENSE
Makefile
package.json
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**This project is outdated. We've built it with Hapi.js v3.0 and Node v0.10.26.**  
**There is a another similar example working with newer versions here: https://github.com/rcorral/hapi-restful-api-example**

## Sample hapi.js REST API

A sample structure for building a REST API on top of `hapi.js` framework that consumes a `MySQL` database.

---
Start by cloning this repo and going inside the project's folder:

```shell
$ git clone git@github.com:agendor/sample-hapi-rest-api.git
$ cd sample-hapi-rest-api
```

To begin with, we have to define some environment variables (with an Ubuntu 12.04 you can edit the `~/.bashrc` file):

```shell
export NODE_ENV=development
export NODE_HOST=localhost
export NODE_PORT=8000
export DB_DEV_USER=root
export DB_DEV_PASS=rootpass
```

**PS**: Don't forget to alter `DB_DEV_USER` AND `DB_DEV_PASS` values properly to access your MySQL Database.

Then you have to give permission to the script `database.sh`:

```shell
$ chmod +x database.sh
```

After giving permission, you can run it. It's going to drop and then re-create a MySQL Database called **hapi-todo** with `user` and `task` tables and insert a default user, which credentials are:

* Email: user1@customer1.com
* Pass: 123

So run it:

```shell
$ bash database.sh
```

Database setup. So it's time to install project dependencies, run the following command:

```shell
$ npm install
```

Now you can check the recently created database in you MySQL. Start the server by running `grunt` in the terminal:

```shell
$ grunt
```

All the unit tests will run and everything should be green.

That's it! You should be able to play around your API GETting, POSTing, PUTing AND DELETEing Tasks. The end-points are as described in the `src/routes/task.js` file:

* **GET** http://localhost:8000/tasks/{task_id}
* **GET** http://localhost:8000/tasks
* **POST** http://localhost:8000/tasks
* **PUT** http://localhost:8000/tasks/{task_id}
* **DELETE** http://localhost:8000/tasks/{task_id}

## Further reading

If you want a deeper analysis of the project, checkout [this Gist](https://gist.github.com/agendor/9922151).

sample-hapi-rest-api

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

sample-hapi-rest-api

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README