https://github.com/webdevcaptain/aa-hackathon-backend
BackEnd for Account Aggregator Hackathon.
https://github.com/webdevcaptain/aa-hackathon-backend
Last synced: 3 months ago
JSON representation
BackEnd for Account Aggregator Hackathon.
- Host: GitHub
- URL: https://github.com/webdevcaptain/aa-hackathon-backend
- Owner: WebDevCaptain
- Created: 2020-07-23T06:22:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T18:05:07.000Z (over 2 years ago)
- Last Synced: 2023-03-04T03:10:53.526Z (over 2 years ago)
- Language: JavaScript
- Size: 301 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **API Documentation for AA Hackathon Backend**
## Base Routes
( Just for Testing GET requests )
- ### GET `/`
### Returns
> A greeting `string`
HTTP Status Code: `200`
---
---
## User Routes
> **NOTE** : **UserPayload structure**
```json
{
"age": Number,
"_id": Unique ID(MongoDB ID),
"name": String,
"email": String,
"createdAt": Date,
"updatedAt": Date,
}
```
---
- ### POST `/auth/users/login`
#### Payload:
```json
{
"email": "String",
"password": "String"
}
```
#### Return Value: `JSON`
```json
{
"user": UserPayload,
"token": JWT
}
```
HTTP Status Code: `200`
---
- ### POST `/auth/users/signup`
#### Payload:
```json
{
"email": "String",
"password": "String",
"name": String,
"age": Number(Optional)
}
```
#### Return Value: `JSON`
```json
{
"user": UserPayload,
"token": JWT
}
```
HTTP Status Code: `201`
---
- ### POST `/auth/users/logout`
#### Payload (Headers):
> Authorization: JWT Bearer Token
#### Return Value: `JSON`
```json
{
"message": String
}
```
HTTP Status Code: `200`
---
### Revokes all User sessions i.e. "Logs out him/her from all active logins"
- ### POST `/auth/users/revokeAll`
#### Payload (Headers):
> Authorization: JWT Bearer Token
#### Return Value: `JSON`
```json
{
"message": String
}
```
HTTP Status Code: `200`
---
### Fetches User Profile
- ### GET `/auth/users/me`
#### Payload (Headers):
> Authorization: JWT Bearer Token
#### Return Value: `JSON` User Payload
HTTP Status Code: `200`
---
### Deletes User Profile
- ### DELETE `/auth/users/me`
#### Payload (Headers):
> Authorization: JWT Bearer Token
#### Return Value: `JSON` User Payload
HTTP Status Code: `200`
---
### Updates User Profile
- ### PATCH `/auth/users/me`
#### Payload (Headers and Body):
> Authorization: JWT Bearer Token
> Body:
```json
"name": String (Optional),
"age": Number (Optional),
"email": String (Optional),
"password": String (Optional),
```
#### Return Value: `JSON` User Payload
HTTP Status Code: `200`