Simple Falcon Template with PostgreSQL for REST API
(Falcon is a high-performance Python framework for building cloud APIs, smart proxies, and app backends. More information can be found here)
Demo: https://falcon-rest-api.herokuapp.com
Make sure that you have already the required packages installed before beginning.
Update your system
sudo apt-get update
sudo apt-get upgrade
Install required packages
sudo apt-get install build-essential python-pip libffi-dev python-dev python3-dev libpq-dev
Install virtualenvwrapper for Python 3.4 (in case you get an error no suitable python virtual env tool found, aborting while running an install.sh )
sudo apt-get install python3.4-venv
Install postgres for psycopg2 dependency
brew update
brew install postgres
Install all the python module dependencies in requirements.txt
./install.sh
Activate virtualenv
.venv/bin/activate
Start server
./bin/run.sh start
You might need to set APP_ENV enviroenment variable to load conf/live.ini configuration before deploying
To run in live mode
export APP_ENV=live
./bin/run.sh startSetting up a live configuration on Heroku (more details here)
heroku config:set APP_ENV=liveCreate an user
- Request
curl -XPOST http://localhost:5000/v1/users -H "Content-Type: application/json" -d '{
"username": "test1",
"email": "test1@gmail.com",
"password": "test1234"
}'- Response
{
"meta": {
"code": 200,
"message": "OK",
},
"data": null
}Log in with email and password
- Request
curl -XGET http://localhost:5000/v1/users/self/login -d email=test1@gmail.com -d password=test1234- Response
{
"meta": {
"code": 200,
"message": "OK"
},
"data": {
"username": "test1",
"token": "gAAAAABV-TpG0Gk6LhU5437VmJwZwgkyDG9Jj-UMtRZ-EtnuDOkb5sc0LPLeHNBL4FLsIkTsi91rdMjDYVKRQ8OWJuHNsb5rKw==",
"email": "test1@gmail.com",
"created": 1442396742,
"sid": "3595073989",
"modified": 1442396742
}
}Check the validation of requested data
- Requset
curl -XPOST http://localhost:5000/v1/users -H "Content-Type: application/json" -d '{
"username": "t",
"email": "test1@gmail.c",
"password": "123"
}'- Response
{
"meta": {
"code": 88,
"message": "Invalid Parameter",
"description": {
"username": "min length is 4",
"email": "value does not match regex '[a-zA-Z0-9._-]+@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,4}'",
"password": [
"value does not match regex '[0-9a-zA-Z]\\w{3,14}'",
"min length is 8"
]
}
}
}Get database rollback error in response for duplicated data
- Request
curl -XPOST http://localhost:5000/v1/users -H "Content-Type: application/json" -d '{
"username": "test1",
"email": "test1@gmail.com",
"password": "test1234"
}'- Response
{
"meta": {
"code": 77,
"message": "Database Rollback Error",
"description": {
"details": "(psycopg2.IntegrityError) duplicate key value violates unique constraint \"user_email_key\"\nDETAIL: Key (email)=(test1@gmail.com) already exists.\n",
"params": "{'username': 'test1', 'token': 'gAAAAABV-UCq_DneJyz4DTuE6Fuw68JU7BN6fLdxHHIlu42R99sjWFFonrw3eZx7nr7ioIFSa7Akk1nWgGNmY3myJzqqbpOsJw==', 'sid': '6716985526', 'email': 'test1@gmail.com', 'password': '$2a$12$KNlGvL1CP..6VNjqQ0pcjukj/fC88sc1Zpzi0uphIUlG5MjyAp2fS'}"
}
}
}Get a collection of users with auth token
- Request
curl -XGET http://localhost:5000/v1/users/100 -H "Authorization: gAAAAABV6Cxtz2qbcgOOzcjjyoBXBxJbjxwY2cSPdJB4gta07ZQXUU5NQ2BWAFIxSZlnlCl7wAwLe0RtBECUuV96RX9iiU63BP7wI1RQW-G3a1zilI3FHss="- Response
{
"meta": {
"code": 200,
"message": "OK"
},
"data": [
{
"username": "test1",
"token": "gAAAAABV-UCAgRy-ee6t4YOLMW84tKr_eOiwgJO0QcAHL7yIxkf1fiMZfELkmJAPWnldptb3iQVzoZ2qJC6YlSioVDEUlLhG7w==",
"sid": "2593953362",
"modified": 1442398336,
"email": "test1@gmail.com",
"created": 1442398336
},
{
"username": "test2",
"token": "gAAAAABV-UCObi3qxcpb1XLV4GnCZKqt-5lDXX0YAOcME5bndZjjyzQWFRZKV1x54EzaY2-g5Bt47EE9-45UUooeiBM8QrpSjA==",
"sid": "6952584295",
"modified": 1442398350,
"email": "test2@gmail.com",
"created": 1442398350
},
{
"username": "test3",
"token": "gAAAAABV-UCccDCKuG28DbJrObEPUMV5eE-0sEg4jn57usBmIADJvkf3r5gP5F9rX5tSzcBhuBkDJwEJ1mIifEgnp5sxc3Z-pg==",
"sid": "8972728004",
"modified": 1442398364,
"email": "test3@gmail.com",
"created": 1442398364
}
]
}