README.md

Todo API

• Todo API
  • Requirements
  • Setup
    • API
    • .env file
    • Playground
  • Endpoints
    • Get all tasks - GET /task
    • Add task - POST /task
    • Get task by id - GET /task/:id
    • Edit task by id - PATCH /task/:id
    • Delete task by id - DELETE /task/:id
  • Model
    • Task

Requirements

• PHP 7
• MariaDB/MySQL
• docker and docker-compose

Setup

API

Run docker container

docker-compose up --build

Access container and install dependencies

# get container id
docker ps

# access container
docker exec -it <container-id> /bin/bash

# in container
composer install

.env file

Create a .env file in the root of the project with your database details. Use .env.example as template.

The application will be accessible at http://localhost:4001

Playground

You can test endpoints with the api playground at: http://localhost:

Endpoints

Get all tasks GET /task

Response

{
  "success": "Boolean of response success",
  "data": "Returned data",
  "code": "HTTP response code",
  "message": "Response message"
}

Add task - POST /task

Request

{
  "description": "task description",
  "starred": "highlighted task",
  "due": "due date"
}

Response

{
  "success": "Boolean of response success",
  "message": "Response message"
}

Get task by id - GET /task/:id

Response

{
  "success": "Boolean of response success",
  "data": "Returned data",
  "code": "HTTP response code",
  "message": "Response message"
}

Edit task by id - PATCH /task/:id

Response

{
  "success": "Boolean of response success",
  "data": "Returned data",
  "code": "HTTP response code",
  "message": "Response message"
}

Delete task by id - DELETE /task/:id

Response

{
  "success": "Boolean of response success",
  "data": "Returned data",
  "code": "HTTP response code",
  "message": "Response message"
}

---

Model

Task

Schema

{
  "id": "unique identifier",
  "description": "task description",
  "completed": "date completed. **NULL** if not completed",
  "starred": "Int. highlighted tasks",
  "created": "date created",
  "modified": "date edited",
  "due": "due date"
}