Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fraigo/node-express-rest-api-example
A Basic Node.js/Express REST API implementation example
https://github.com/fraigo/node-express-rest-api-example
expressjs nodejs rest-api
Last synced: 4 days ago
JSON representation
A Basic Node.js/Express REST API implementation example
- Host: GitHub
- URL: https://github.com/fraigo/node-express-rest-api-example
- Owner: fraigo
- Created: 2018-12-29T21:10:49.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:39:12.000Z (almost 2 years ago)
- Last Synced: 2023-03-01T16:46:11.386Z (over 1 year ago)
- Topics: expressjs, nodejs, rest-api
- Language: JavaScript
- Size: 71.3 KB
- Stars: 62
- Watchers: 4
- Forks: 52
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-express-rest-api-example
A Basic Node.js/Express REST API implementation example.
Full Tutorial at https://developerhowto.com/2018/12/29/build-a-rest-api-with-node-js-and-express-js/
# Prerequisites
For Windows
* Python 2.7 (for microsoft build tools)
* Install Microsoft build tools (to build sqlite using node-gyp)
* Instructions here https://github.com/nodejs/node-gyp#on-windows
* Or install using npm (`npm install --global windows-build-tools`)
* Node-gyp (`npm install --global node-gyp`)
# Usage
* Run `npm install` to installl dependencies
* Run `npm run start` to start the local server
* Load `http://localhost:8000` to test the endpoint. It will display a json result `{"message":"Ok"}`
# API Endpoints
## GET /api/users
Get a list of users
```json
{
"message": "success",
"data": [
{
"id": 1,
"name": "admin",
"email": "[email protected]",
"password": "a66abb5684c45962d887564f08346e8d"
},
{
"id": 2,
"name": "user",
"email": "[email protected]",
"password": "4da49c16db42ca04538d629ef0533fe8"
}
]
}
```
## GET /api/user/{id}
Get user information by user id
```json
{
"message": "success",
"data": {
"id": 1,
"name": "admin",
"email": "[email protected]",
"password": "a66abb5684c45962d887564f08346e8d"
}
}
```
## POST /api/user/
To create a new user based on POST data (x-www-form-url-encoded)
* name: User name
* email: User email
* password: User password
## PATCH /api/user/{id}
To update user data by id, based on POST data (x-www-form-url-encoded)
* name: User name
* email: User email
* password: User password
You can send only one attribute to update, the rest of the info remains the same.
In this example, using CURL you can update the user email:
```bash
curl -X PATCH -d "[email protected]" http://localhost:8000/api/user/2
```
## DELETE /api/user/{id}
To remove a user from the database by user id.
This example is using the `curl` command line
```bash
curl -X "DELETE" http://localhost:8000/api/user/2
```
The result is:
`{"message":"deleted","rows":1}`