API Demo : https://glacial-ocean-84777.herokuapp.com/

App Demo : https://bukanban2.web.app/

Kanban Server

Kanban is an application to manage organization's tasks. This app has :

RESTful endpoint for task's CRUD operation
authorization
JSON formatted response

RESTful endpoints

POST /register

Create new user

Request Header

not needed

Request Body

{
  "name": <your name>,
  "email": <your email>,
  "password": <your password>
}

Success Response:

Response (201 - Created)

{
  "id": <id>,
  "name": <your name>,
  "email": <your email>,
  "password": <your encrypted password>,
  "updatedAt": <date>,
  "createdAt": <date>
}

Error Response:

Response (400 - Bad Request)

[
  "message": <detail message>
]

Response (409 - conflict)

{
  "message": "Email Already registered!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

POST /login

Process Login

Request Header

not needed

Request Body

{
  "email": <your email>,
  "password": <your password>
}

Success Response:

Response (200 - Ok)

{
  "access_token": <your access token>
}

Error Response:

Response (400 - Bad Request)

[
  "message": <detail message>
]

Response (404 - Not Found)

{
  "message": "user not registered!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

POST /tasks

Create new task

Request Header

{
  "access_token": <your access token>
}

Request Body

{
	"title": <title>
	"category": <category>
	"description": <description> 
}

Success Response:

Response (201 - Created)

{
  "id": <id>,
  "title": <title>,
  "description": <description> ",
  "category": <category>,
  "UserId": <UserId>,
  "updatedAt": <date>,
  "createdAt": <date>
}

Error Response:

Response (400 - Bad Request)

[
  "message": <message detail>
]

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

GET /tasks

Get User's tasks

Request Header

{
  "access_token": <your access token>
}

Request Body

not needed

Success Response:

Response (200 - Ok)

[
	{
    "id": <id>,
    "title": <title>,
    "description": <description>,
    "category": <category>,
    "UserId": <UserId>,
    "Creator": <your name>
	},
	{
    "id": <id>,
    "title": <title>,
    "description": <description>,
    "category": <category>,
    "UserId": <UserId>,
    "Creator": <your name>
	},
]

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

GET /tasks/:id

Get task by task's id

Request Header

{
  "access_token": <your access token>
}

Request Body

not needed

Success Response:

Response (200 - Ok)

{
  "id": <id>,
  "title": <title>,
  "description": <description>,
  "category": <category>,
  "UserId": <UserId>,
  "Creator": <your name>
},

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (403 - Forbidden)

{
  "message": "Forbidden access!"
}

Response (404 - Not Found)

{
  "message": "task not found! "
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

PUT /tasks/:id

Update task

Request Header

{
  "access_token": <your access token>
}

Request Body

{
	"title": <title> "
	"category": <category>
	"description": <description>"
}

Success Response:

Response (200 - Created)

{
  "message": "Update task success"
}

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (403 - Forbidden)

{
  "message": "Forbidden access!"
}

Response (404 - Not Found)

{
  "message": "task not found! "
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

DELETE /tasks/:id

Update task

Request Header

{
  "access_token": <your access token>
}

Request Body

not needed

Success Response:

Response (200 - Ok)

{
  "message": "Delete task success"
}

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (403 - Forbidden)

{
  "message": "Forbidden access!"
}

Response (404 - Not Found)

{
  "message": "task not found! "
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

2maleek / new_kanban Goto Github PK

new_kanban's Introduction

API Demo : https://glacial-ocean-84777.herokuapp.com/

App Demo : https://bukanban2.web.app/

Kanban Server

RESTful endpoints

POST /register

Success Response:

Error Response:

POST /login

Success Response:

Error Response:

POST /tasks

Success Response:

Error Response:

GET /tasks

Success Response:

Error Response:

GET /tasks/:id

Success Response:

Error Response:

PUT /tasks/:id

Success Response:

Error Response:

DELETE /tasks/:id

Success Response:

Error Response:

new_kanban's People

Contributors

Watchers

Recommend Projects

Recommend Topics

Recommend Org