jintae1954 / todo-api

사각 토이 프로젝트-백엔드

Todo API

Table of contents

• Overview
• The Challenge
• Built with
• Endpoints
• Deployment
• Author

Overview

I made this API for my Todo App to handle user registration, authentication, CRUD operations of todo items and saving data in MongoDB.

The Challenge

API should handle the following:

• Create a new user and save user data in the database
• User Sign in Process & sending authentication token
• User Sign out Process & deleting authentication token
• Create a new todo for a user and save it in the database
• Get all todo items of the user
• Delete a todo item from the database

Built with

• Node JS - JavaScript runtime environment
• Express JS - Web Framework for Node JS
• JWT
• MongoDB - No-SQL Database

Endpoints

Create New User

[POST] "http://localhost:4000/sign_up"

Method	POST
Body	{"name": "Hatem" , "email": "[email protected]" , "password": "123456"}

Sign in a user

[POST] "http://localhost:4000/sign_in"

Method	POST
Body	{"email": "[email protected]" , "password": "123456"}

Sign out a user

[GET] "http://localhost:4000/sign_out"

Method	GET

Get a user information (name and email)

[GET] "http://localhost:4000/user"

Method	GET

Get all todo items of a user

[GET] "http://localhost:4000/1"

Method	GET
Parameters	User Id

Create a new todo item

[POST] "http://localhost:4000/1"

Method	POST
Parameters	User Id
Body	{"content": "learn a new language"}

Delete a todo item

[DELETE] "http://localhost:4000/1/2"

Method	DELETE
Parameters	User Id, Todo Id

Deployment

• Deployed on Cyclic, API Endpoint: (https://todo-api-nodejs.cyclic.app/)

Author

• Linkedin - Hatem Mohamed