A simple backend server application that manage documents and persist data.
- Create, Read, Update, and Delete (CRUD) Document
- CRUD User
- User login
cd simple-backend
- make sure your
python
command is using python3, or use a virtual env by:python3 -m venv venv
create virtual env (skip if already created). venv/bin/activate
use virtual env
- make sure dependencies (i.e. django) are installed, or install it by:
python -m pip install -r requirements.txt
./start-dev.sh
- This script will use the example db:
mv db.sqlite3.example db.sqlite3
- This script will use the example db:
- go to http://127.0.0.1:8000/documents
- GET
/documents
- return
{ id: string, name: string }[]
- return
- GET
/documents/:document_id
- return
{ id: string, name: string, textPack: string, ontology: string }
- return
- POST
/documents/new
- params
{ name: string, textPack: string, ontology: string }
- return
{ id: string }
- params
- POST
/documents/:document_id/edit/name
- params
{ name: string }
- return
OK
- params
- POST
/documents/:document_id/edit/textpack
- params
{ textPack: string }
- return
OK
- params
- POST
/documents/:document_id/edit/ontology
- params
{ ontology: string }
- return
OK
- params
- POST
/documents/:document_id/delete
- return
OK
- return
- POST
/documents/:document_id/annotations/new
- params
{ data: string (json) }
- return
{ id: string }
- params
- POST
/documents/:document_id/annotations/:annotation_id/edit
- params
{ data: string (json) }
- return
OK
- params
- POST
/documents/:document_id/annotations/:annotation_id/delete
- return
OK
- return
- POST
/documents/:document_id/links/new
- params
{ data: string (json) }
- return
{ id: string }
- params
- POST
/documents/:document_id/links/:link_id/edit
- params
{ data: string (json) }
- return
OK
- params
- POST
/documents/:document_id/links/:link_id/delete
- return
OK
- return
- GET
/users
- return
{ id: string, name: string }[]
- return
- GET
/users/:user_id
- return
{ id: string, name: string }
- return
- POST
/users/new
- params
{ name: string, password: string }
- return
OK
- params
- POST
/users/:user_id/edit
- params
{ name: string, password: string }
- return
OK
- params
- POST
/users/:user_id/delete
- return
OK
- return
- POST
/login
- params
{ name: string, password: string}
- params
- GET
/logout