thibgn / djangoapi

A simple todo API made with Django & DRF

Django Todo API

This is a simple todo API allowing authenticated users to create tasks & tasklists. Made with django-rest-framework, drf_spectacular and dj-rest-auth.

Deploy locally

To try it out, just run the following commands :

git clone [email protected]:gerthi/djangoAPI.git
cd djangoAPI

# install the requirements
pip install -r requirements.txt

# setup the database
python manage.py makemigrations todos
python manage.py migrate

# run the server
python manage.py runserver

Open your browser and visit localhost:8080 !

Usage

The following endpoints are available to authenticated users :

• /tasks/ read, create, edit, delete tasks
• /tasklists/ read, create, edit, delete tasklists
• /docs/ view a complete swagger API documentation
• /auth/ login & logout

Creating users

You can either create users in the CLI by running python manage.py createsuperuser or through the Djangon admin interface.

Improvements

• Being able to create tasks without a tasklist when there are tasklists available
• Better authentication
• Improved documentation