README.md

Algobulls Todo API

Table of Contents

• Algobulls Todo API
  • Table of Contents
  • Getting Started
    • Or you can run it locally
  • API Endpoints
    • Get a list of all the tasks
    • Create a new task
    • Get a task by id
    • Update a task by id
    • Delete a task by id
  • Authentication
    • Register a new user

Getting Started

The API is available at https://algobulls-todo.onrender.com/

You can see the documentation at https://algobulls-todo.onrender.com/

Or you can run it locally

1. Clone the repository
2. Install the dependencies

pip install -r requirements.txt

3. Run the server

python manage.py runserver

4. The API is now available at http://localhost:8000/
5. You can see the documentation at http://localhost:8000/
6. You can also see the documentation at http://localhost:8000/

API Endpoints

Get a list of all the tasks

GET /api/tasks/

curl -X GET https://algobulls-todo.onrender.com/api/todos/ -u "username:password"

Create a new task

POST /api/tasks/

curl -X POST https://algobulls-todo.onrender.com/api/todos/ -u "username:password" -H "Content-Type: application/json" -d '{"title": "string", "description": "string", "status": "string", "due_date": "string", "tags": ["string"]}'

Get a task by id

GET /api/tasks/{id}/

curl -X GET https://algobulls-todo.onrender.com/api/todos/{id}/ -u "username:password"

Update a task by id

PUT /api/tasks/{id}/

curl -X PUT https://algobulls-todo.onrender.com/api/todos/{id}/ -u "username:password" -H "Content-Type: application/json" -d '{"title": "string", "description": "string", "status": "string", "due_date": "string", "tags": ["string"]}'

Delete a task by id

DELETE /api/tasks/{id}/

curl -X DELETE https://algobulls-todo.onrender.com/api/todos/{id}/ -u "username:password"

Authentication

Register a new user

POST /api/auth/register/

curl -X POST https://algobulls-todo.onrender.com/api/auth/register/ -H "Content-Type: application/json" -d '{"username": "string", "password": "string"}'