/todo-app-api

Primary LanguagePython

Flask Task API Documentation

This Flask application provides a simple API for managing tasks.

Table of Contents

  1. Get All Tasks
  2. Get Task by ID
  3. Add New Task
  4. Update Task
  5. Delete Task

1. Get All Tasks

  • Endpoint: /tasks (GET)
  • Description: Get a list of all tasks.
  • Sample Response: 
    {
    "tasks": [
        {"id": 1, "title": "Task 1", "done": false},
        {"id": 2, "title": "Task 2", "done": true},
        // Additional tasks...
    ]
}

2. Get Task by ID

  • Endpoint: /task/int:task_id (GET)
  • Description: Get details of a task by its ID.
  • Sample Response: 
    {
"id": 1,
"title": "Task 1",
"done": false
}
  • Error response: 
    {
  "error": "Task not found"
}

3. Add New Task

  • Endpoint: /tasks (POST)
  • Description: Add a new task.
  • Request Body: 
    {
    "title": "New Task"
}

4. Update Task

  • Endpoint: /tasks/<int:task_id> (PUT)
  • Description: Update details of a task by its ID.
  • Request Body: 
    {
    "title": "Updated Task",
    "done": true
}
  • Error response: 
    {
  "error": "Task not found"
}

5. Delete Task

  • Endpoint: /tasks/<int:task_id> (DELETE)
  • Description: Delete a task by its ID.
  • Sample Response: 
    {
    "result": true
}
  • Error response: 
    {
  "error": "Task not found"
}