README_TODO.md

todo-server

CREATE NEW TODO

Return JSON data of created list

• URL

  /todos/

• Method:

  POST

• URL Params

  Required:

  none

  Optional:

  none

• Data Params

  id = [integer], title = [string], description = [string], status = [boolean], due_date = [date], createdAt = [date], updatedAt = [date]

• Success Response:

  • Code: 201
    Content: { "id": 2, "title": "buat aplikasi todo", "description": "menggunakan rest api", "status": false, "due_date": "2020-03-02T00:00:00.000Z", "updatedAt": "2020-03-02T08:25:05.545Z", "createdAt": "2020-03-02T08:25:05.545Z" }

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { error : "title cannot be empty" }

  • OR

  • Code: 400 BAD REQUEST
    Content: { error : "date inputted should be at least starting from now" }

SHOW LIST

Return JSON on "Todos" table

• URL

  /todos/

• Method:

  GET

• URL Params

  Required:

  id = [integer]

  Optional:

  none

• Data Params

  id = [integer], title = [string], description = [string], status = [boolean], due_date = [date], createdAt = [date], updatedAt = [date]

• Success Response:

  • Code: 200
    Content: { "id": 2, "title": "buat aplikasi todo", "description": "menggunakan rest api", "status": false, "due_date": "2020-03-02T00:00:00.000Z", "updatedAt": "2020-03-02T08:25:05.545Z", "createdAt": "2020-03-02T08:25:05.545Z" }

• Error Response:

  • Code: 401
    Content: { error : "you must login first" }

SHOW LIST BY ID

Return JSON on "Todos" table by id

• URL

  /todos/:id

• Method:

  GET

• URL Params

  Required:

  id=[integer]

  Optional:

  none

• Data Params

  id = [integer], title = [string], description = [string], status = [boolean], due_date = [date], createdAt = [date], updatedAt = [date]

• Success Response:

  • Code: 200
    Content: { "id": 2, "title": "buat aplikasi todo", "description": "menggunakan rest api", "status": false, "due_date": "2020-03-02T00:00:00.000Z", "updatedAt": "2020-03-02T08:25:05.545Z", "createdAt": "2020-03-02T08:25:05.545Z" }

• Error Response:

  • Code: 404 ERROR NOT FOUND
    Content: { error : "id todo not found" }

EDIT DATA BY ID

Return JSON of edited data by id

• URL

  /todos/:id

• Method:

  PUT

• URL Params

  Required:

  id = [integer], title = [string], description = [string], status = [boolean], due_date = [date]

  Optional:

  none

• Data Params

  id = [integer], title = [string], description = [string], status = [boolean], due_date = [date], createdAt = [date], updatedAt = [date]

• Success Response:

  • Code: 200
    Content: { "id": 2, "title": "buat aplikasi todo", "description": "menggunakan rest api", "status": false, "due_date": "2020-03-02T00:00:00.000Z", "updatedAt": "2020-03-02T08:25:05.545Z", "createdAt": "2020-03-02T08:25:05.545Z" }

• Error Response:

  • Code: 404 ERROR NOT FOUND
    Content: { error : "id todo not found" }

DELETE DATA BY ID

number of deleted row

• URL

  /todos/:id

• Method:

  DELETE

• URL Params

  Required:

  id=[integer]

  Optional:

  none

• Data Params

  none

• Success Response:

  • Code: 200
    Content: 1

• Error Response:

  • Code: 404 ERROR NOT FOUND
    Content: { error : "id todo not found" }