Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sujilnt/todoapi
A REST API for Todo Application
https://github.com/sujilnt/todoapi
bcrypt express mongodb nodejs
Last synced: 2 days ago
JSON representation
A REST API for Todo Application
- Host: GitHub
- URL: https://github.com/sujilnt/todoapi
- Owner: sujilnt
- Created: 2019-06-06T22:51:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T23:35:25.000Z (about 2 years ago)
- Last Synced: 2024-12-06T22:08:19.689Z (about 1 month ago)
- Topics: bcrypt, express, mongodb, nodejs
- Language: JavaScript
- Size: 1.83 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### TodoAPI
A REST API for Todo Application.
#### Usage
`yarn install`
`yarn run dev`
#### API EndPoint
1.`/Signup (Post Req)` - Creating a new account for users.
2. `/Signin (Post Req)` - A user sign sign in the api, so that he can access the data using api
3. `/api/task (Post, GET Req)` - A set of operation can be done like add,get todo tasks based on each user.
4. `/api/task/:id (Get,Post,Delete,PUT Requests)` - A set of operation can be done like get delete, update, get and post, remove based on each user.
5. `/api/archive (GET)` - To get all the archive tasks.
` The above 1 and 2 are not protected routes but 3 and 4 are protected routes requires token.`
```
Steps to use Api
1) Create an Account first by send a /signup post request , If status is 200 then token is created as response.
1) Create an Account first by send a /signup post request , If status is 200 then token is created as response.
2)Each token is created for each user to inorder to identify each todo tasks.
```
#### `Signup (Post Req)`
POST /signup - create User inorder to have a token
Example code
```
async function resAsync(){
data = {
"email": "[email protected]",
"password": "t12"
}
let res = await fetch("http://localhost:3030/signup",{
method: "POST",
mode: 'cors', // no-cors, cors, *same-origin
cache: 'no-cache', // *de
body:JSON.stringify(data),
headers: {"Content-type":"application/json;charset=utf-8"}
})
const r1 = await res.json()
return r1;
}
```
#### `Signin (Post Req)`
POST /sigin
Example code
```
async function resAsync(){
data = {
"email": "[email protected]",
"password": "t12"
}
let res = await fetch("http://localhost:3030/signin",{
method: "POST",
mode: 'cors', // no-cors, cors, *same-origin
cache: 'no-cache', // *de
body:JSON.stringify(data),
headers: {"Content-type":"application/json;charset=utf-8"}
})
const r1 = await res.json()
return r1;
}
```
#### `/Api/Task/`
GET /api/task - get all the task names unarchived task names
Example
```
async function resAsync(){
let res = await fetch("http://localhost:3030/api/task",{
method: "GET",
mode: 'cors', // no-cors, cors, *same-origin
cache: 'no-cache', // *de
headers: {
"Content-type":"application/json;charset=utf-8",
Authorization : "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjZmQ5NGQ2NmEwZTc5MzBmMGFlNDc3OCIsImlhdCI6MTU2MDEyMjU4MiwiZXhwIjoxNTY4NzYyNTgyfQ.fVvrvtae1BGWw_8W4PJ28aGmfjoIOtoq_7YmyWZLlTM"
}
});
let r1= await res.json();
return r1;
}
resAsync();
```
POST /api/task
Require Fields are as Uid and name by archieved will be false.
#### `/api/archive (GET)`
GET /api/archive - to get all the deleted items
1) Requires Authorisation , image Below
##### `/api/task:id`
GET /api/task:id - for getting the current task details
PUT /api/task:id - updating the exsisting task.
DELETE /api/task:id - Removing from the Database .
