Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yusufshakeel/node-api-project

This is a simple Node project to create a simple API server.
https://github.com/yusufshakeel/node-api-project

api express expressjs javascript jest jwt mongoose node nodejs restful-api

Last synced: 7 days ago
JSON representation

This is a simple Node project to create a simple API server.

Host: GitHub
URL: https://github.com/yusufshakeel/node-api-project
Owner: yusufshakeel
License: mit
Created: 2019-07-08T01:00:34.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-07T07:44:39.000Z (almost 2 years ago)
Last Synced: 2024-04-15T15:52:43.777Z (7 months ago)
Topics: api, express, expressjs, javascript, jest, jwt, mongoose, node, nodejs, restful-api
Language: JavaScript
Size: 1.08 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 19
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# node-api-project

This is a simple Node project to create a simple API server.

## Prerequisite

* Node >= v8
* NPM >= v6
* MongoDB >= v3

## Features of this project
* User sign up
* User log in
* User authentication using JWT (JSON Web Token)
* Update user account data (own account) only after log in
* View all users (public info) using pagination
* View user (public info) using id
* View full user account data (own account) only after log in
* Delete user account (own account) only after log in

## Tests
Test code of this project is inside the `tests` directory.

Using the following for testing:
* Jest
* Supertest

## How to use this project?

1. Download the project code.
2. Run `npm init` to install the packages.
3. Setup environment variables
```
$ export node_api_project_jwtPrivateKey=secretKey
$ export node_api_project_PORT=3000
```
If you don't set the PORT then default port 3000 will be used.

4. Run the project `node index.js` or `nodemon`.

## APIs

### User - Sign up

```
POST /api/users
Host: localhost:3000
Content-Type: application/json

{
"first_name": "Yusuf",
"last_name": "Shakeel",
"email": "[email protected]",
"password": "root1234"
}
```

Response

```JSON
{
"code": 200,
"status": "success",
"data": {
"_id": "5d29b9e42ef2dc359a2640ee",
"first_name": "Yusuf",
"last_name": "Shakeel",
"email": "[email protected]"
}
}
```

### User - Log in

```
POST /api/users/login
Host: localhost:3000
Content-Type: application/json

{
"email": "[email protected]",
"password": "root1234"
}
```

Response

```JSON
{
"code": 200,
"status": "success",
"data": {
"_id": "5d29b9e42ef2dc359a2640ee",
"first_name": "Yusuf",
"last_name": "Shakeel",
"email": "[email protected]"
}
}
```

JWT will be present in the header. Check `x-auth-token`.

### User - List all active users

```
GET /api/users
Host: localhost:3000
```

Response

```JSON
{
"code": 200,
"status": "success",
"data": [
{
"_id": "5d2461f8e4dd952b8f005b9e",
"first_name": "Yusuf",
"last_name": "Shakeel"
},
{
"_id": "5d24629cc55c602bc69c5468",
"first_name": "John",
"last_name": "Doe"
},
{
"_id": "5d2462a7c55c602bc69c5469",
"first_name": "Jane",
"last_name": "Doe"
}
]
}
```

### User - User public info by id

```
GET /api/users/5d2461f8e4dd952b8f005b9e
Host: localhost:3000
```

Response

```JSON
{
"code": 200,
"status": "success",
"data": {
"_id": "5d2461f8e4dd952b8f005b9e",
"first_name": "Yusuf",
"last_name": "Shakeel"
}
}
```

### User - Full account data (for logged in user)

```
GET /api/users/me
Host: localhost:3000
x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDI0NjFmOGU0ZGQ5NTJiOGYwMDViOWUiLCJpc1VzZXIiOnRydWUsImV4cCI6MTU2MzAxOTUzMSwiaWF0IjoxNTYzMDE1OTMxfQ.EY_5GJzqrfaHAwi6g5kvrA5FUKCXclTD1F0eTpq8ZQk
```

Don't forget to pass the `x-auth-token` in the header.

Response

```JSON
{
"code": 200,
"status": "success",
"data": {
"_id": "5d2461f8e4dd952b8f005b9e",
"first_name": "Yusuf",
"last_name": "Shakeel",
"email": "[email protected]",
"account_status": "ACTIVE"
}
}
```

### User - Update account data (for logged in user)

```
PUT /api/users
Host: localhost:3000
x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDI0NjFmOGU0ZGQ5NTJiOGYwMDViOWUiLCJpc1VzZXIiOnRydWUsImV4cCI6MTU2MzAxOTUzMSwiaWF0IjoxNTYzMDE1OTMxfQ.EY_5GJzqrfaHAwi6g5kvrA5FUKCXclTD1F0eTpq8ZQk
Content-Type: application/json

{
"first_name": "Yusuf",
"last_name": "Shakeel",
"password": "root1234",
"account_status": "ACTIVE"
}
```

Don't forget to pass the `x-auth-token` in the header.

Response

### User - Delete account (for logged in user)

```
DELETE /api/users
Host: localhost:3000
x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDI5YzA3MTU4N2NkYzNhOWU4NGZmZDciLCJpc1VzZXIiOnRydWUsImV4cCI6MTU2MzAyMDkzNiwiaWF0IjoxNTYzMDE3MzM2fQ.yjPB2Qe1VIL3iwVJ5XqLtehOVRSReBv2r79ecou9oF0
Content-Type: application/json
```

Don't forget to pass the `x-auth-token` in the header.

Response

```JSON
{
"code": 200,
"status": "success",
"data": "Account deleted."
}
```

## License
It's free.

### Back this project

If you find this project useful and interesting then please support it on [Patreon](https://www.patreon.com/yusufshakeel).

### Donate
Feeling generous :-) [Donate via PayPal](https://www.paypal.me/yusufshakeel)