Simple Flask Todo API

This is a description of the complete API.

Installation

clone the repository

$ cd to/your/favorite/path

$ git clone https://github.com/emilgras/simple-flask-auth.git

$ cd simple-flask-aut

create and activate a local virtual environment

$ python3 -m venv venv

$ source venv/bin/activate

Install dependencies from requirements.txt

(venv) $ pip install -r requirements.txt

Enter the Python interpreter

(venv) $ python3

Create the database

>>> from api import db
>>> db.create_all()

Endpoints

Authentication routes

Method	Endpoint	Description
POST	/login	log's in a user
POST	/register	creates a new user with no access token

Admin routes

Method	Endpoint	Description	Parameters	Result
GET	/user	get all users	---	list of users
GET	/user/<public_id>	get a single user	public_id	single user
PUT	/user/<public_id>	promote user to admin	public_id	---
DELETE	/user/<public_id>	deletes a user	public_id	---

Todo routes

Method	Endpoint	Description	Parameters	Result
GET	/todo	get all users	---	list of todo items
GET	/todo/<todo_id>	get a single todo item	public_id	todo item
PUT	/todo/<todo_id>	complete todo item	todo_id	---
DELETE	/todo/<todo_id>	deletes todo item	public_id	---