Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kazordoon/nodejs-restful-api-hapi
RESTful API made with Node.js.
https://github.com/kazordoon/nodejs-restful-api-hapi
bcrypt hapi hapijs javascript jwt jwt-authentication jwt-token mongodb mongoose nodejs npm restful-api webservice yarn
Last synced: about 3 hours ago
JSON representation
RESTful API made with Node.js.
- Host: GitHub
- URL: https://github.com/kazordoon/nodejs-restful-api-hapi
- Owner: kazordoon
- License: mit
- Created: 2020-02-16T22:39:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T06:04:15.000Z (over 1 year ago)
- Last Synced: 2023-03-04T07:47:46.557Z (over 1 year ago)
- Topics: bcrypt, hapi, hapijs, javascript, jwt, jwt-authentication, jwt-token, mongodb, mongoose, nodejs, npm, restful-api, webservice, yarn
- Language: JavaScript
- Homepage:
- Size: 404 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodejs-restful-api-hapi
RESTful API made with Node.js where a user can list, create, update and delete products that are stored in a database. You will need a token, which will be received when you log in, so that it can handle the products.
## Getting Started
### Prerequisites
- MongoDB
- Redis
- Node.js
- NPM / Yarn
### Installing
- Clone the repository: `git clone https://github.com/kazordoon/nodejs-restful-api-hapi.git`
- Get in the project directory: `cd nodejs-restful-api-hapi`
- Install the dependencies:
- NPM: `npm i` | Remove the file `yarn.lock` before installing with NPM
- Yarn: `yarn`
### Setting environment variables
Copy the `.env.example` file to the` .env`, then you will need to set the variable values into the `.env` file according to your environment.
### Running the server
* NPM: `npm run dev`
* Yarn: `yarn dev`
### API endpoints
#### Products
Action | Path | Parameters | Body | Method | Returns
------ | --- | ---------- | ------ | ------- | -------
List all products | /products | -- | -- | GET | All of the products
List one product | /products/{idProduct} | idProduct | -- | GET | The product that has the same `id` as the one found in the `idProduct` parameter
Create a new product | /products | - | A JSON with the fields `name`, `description` and `price` | POST | The created product
Update a existing product | /products/{idProduct} | idProduct | A JSON with least one of the following fields: `name`, `description` or `price` | PATCH | The updated product
Delete a product | /products/{idProduct} | idProduct | -- | DELETE | --
#### Users
Action | Path | Body | Method | Returns
------ | --- | ---------- | ------ | -------
Create a new user | /register | A JSON with the fields `username` and `password` | POST | A JSON with a success message and a token
Login into an account | /login | A JSON with the fields `username` and `password` | POST | A JSON with a success message and a token
### How to use the token
You need to put the token on the authorization header.
### Input data validation
#### Users
- username
- Type: string
- Minimum characters: 3
- Maximum characters: 20
- password
- Type: string
- Minimum characters: 8
- Maximum characters: 50
#### Products
- name:
- Type: string
- Minimum characters: 2
- Maximum characters: 50
- description
- Type: string
- Minimum characters: 20
- Maximum characters: 200
- price
- Type: number
- Minimum: 0
- Maximum: 10000
## Examples
See the [EXAMPLES.md](EXAMPLES.md).
## Built With
* [Node.js](https://nodejs.org) - JavaScript runtime environment that executes JavaScript code server-side
* [MongoDB](https://www.mongodb.com/) - NoSQL Database
* [mongoose](https://mongoosejs.com) - MongoDB object modeling tool
* [@hapi/hapi](https://hapi.dev) - HTTP server framework
* [@hapi/boom](https://hapi.dev/family/boom) - HTTP-friendly error objects
* [@hapi/joi](https://hapi.dev/family/joi/) - Data validator for JavaScript
* [bcrypt](https://github.com/kelektiv/node.bcrypt.js) - A library to help you hash passwords
* [hapi-auth-jwt2](https://github.com/dwyl/hapi-auth-jwt2) - Authentication scheme/plugin for Hapi.js apps using JSON Web Tokens
* [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) - An implementation of JSON Web Tokens
* [ioredis](https://github.com/luin/ioredis) - A robust, performance-focused and full-featured Redis client for Node.js
## Versioning
For the versions available, see the [tags on this repository](https://github.com/kazordoon/nodejs-restful-api-hapi/tags).
## Authors
* **Felipe Barros** - *Initial work* - [kazordoon](https://github.com/kazordoon)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details