Todo App API

Introduction

In this project, I will be working on the Django REST Framework. I will be implementing a TODO API server. Also, I will be adding some additional functionality to the API.

Setting up the project

• Make sure python3.8 and pip are installed. Install pipenv by running pip install pipenv.
• Install python dependencies using the command pipenv install Please use only pipenv for managing dependencies (Follow this link if you are new to pipenv).
• To activate this project's virtualenv, run pipenv shell.
• Run python manage.py migrate to apply migrations.
• Start the development server using python manage.py runserver

Working

I'll complete two subtasks:

• I will complete all the basic endpoints (API Description is included below):

  Auth - Login, Register, Get Profile and Todo - Get Detail, Get List, Create, Edit and Delete. In this subtask, only the creator of the Todo will have the access to View, Edit or Delete the Todo. The necessary details for this subtask are mentioned in the comments too.

• I will implement collaborator feature:

  In this subtask, I will implement a feature where the creator of a todo can add or remove the collaborators to a todo. Specifically, for every todo, the owner can add one or more collaborator to a todo and can remove one or more collaborators from a todo. So, every todo will have a set of collaborators (may be empty too). The collaborator of a todo will have the access to Edit or Delete the todo, but he won't be able to add or delete the collaborators to the todo. Only the creator of the todo will have the permission to add or remove collaborators.

  For this subtask, I create the two endpoints /todo/{id}/add-collaborators/ and /todo/{id}/remove-collaborators/ for adding and removing collaborators, respectively. Also, I will have to modify the GET Todo endpoint to display all the Todo - the one which the user has created, and the one for which the user is collaborating. I made sure to distinguish between the two of them.

Tasks

• Complete all the basic endpoints

• Collaborator feature

API Description

Auth System

For this API, I have used Token-based Authorization. I have created the serializer and the functions required to create token for a user.. All the requests made to the API (except the Login and Register endpoints) shall need an Authorization header with a valid token and the prefix Token.

The authorization header shall have the following format: Authorization: Token <token>

In order to obtain a valid token it's necessary to send a request POST /auth/login/ with username and password. To register a new user it's necessary to make a request POST /auth/register/ with name, email, username and password.

End Points

Auth

• POST /auth/login/

  Takes the username and password as input, validates them and returns the Token, if the credentials are valid.

  Request Body (Sample):

  {
    "username": "string",
    "password": "string"
  }
  

  Response Body (Sample):

  {
    "token":  "string"
  }
  

  Response Code: 200

• POST /auth/register/

  Register a user in Django by taking the name, email, username and password as input.

  Request Body (Sample):

  {
    "name": "string",
    "email": "user@example.com",
    "username": "string",
    "password": "string"
  }
  

  Response Body (Sample):

  {
    "token":  "string"
  }
  

  Response Code: 200

• POST /auth/profile/

  Retrieve the id, name, email and username of the logged in user. Requires token in the Authorization header.

  Response Body (Sample):

  {
    "id":  1,
    "name":  "string",
    "email":  "user@example.com",
    "username":  "string"
  }
  

  Response Code: 200

Todo

• GET /todo/

  Get all the Todos of the logged in user. Requires token in the Authorization header.

  Response Body (Sample):

  [
    {
      "id":  1,
      "title":  "string"
    },
    {
      "id":  2,
      "title":  "string"
    }
  ]
  

  Response Code: 200

• POST /todo/create/

  Create a Todo entry for the logged in user. Requires token in the Authorization header.

  Request Body (Sample):

  {
    "title": "string"
  }
  

  Response Body (Sample):

  {
    "id":  1,
    "title":  "string"
  }
  

  Response Code: 200

• GET /todo/{id}/

  Get the Todo of the logged in user with given id. Requires token in the Authorization header.

  Response Body (Sample):

  {
    "id":  1,
    "title":  "string"
  }
  

  Response Code: 200

• PUT /todo/{id}/

  Change the title of the Todo with given id, and get the new title as response. Requires token in the Authorization header.

  Request Body (Sample):

  {
    "title": "string"
  }
  

  Response Body (Sample):

  {
    "id":  1,
    "title":  "string"
  }
  

• PATCH /todo/{id}/

  Change the title of the Todo with given id, and get the new title as response. Requires token in the Authorization header.

  Request Body (Sample):

  {
    "title": "string"
  }
  

  Response Body (Sample):

  {
    "id":  1,
    "title":  "string"
  }
  

• DELETE /todo/{id}/

  Delete the Todo with given id. Requires token in the Authorization header.

  Response Code: 204

Testing the API

The API can be tested by running the Django server locally, going to the following url: http://127.0.0.1:8000/, clicking the "Try it out" button after selecting the endpoint and finally executing it along with the Response Body (if required).

For testing the endpoints which require Token in the Authorization header, we can click on the "Authorize" button, write the Authorization token as Token <token> (which you have obtained from the auth/login/ endpoint) and finally click on "Authorize". Thereafter, all the requests made to any endpoint will have the Token in the Authorization Header.