A bottle plugin to json format standard and error responses. Intended for REST APIs.
Project description
=====================
bottle-api-json-formatting
=====================
A Bottle plugin which encapsulates results and errors in a json object. This
makes it much easier to build REST based api services with bottle.
Installation
===============
Install with one of the following commands::
$ pip install bottle-api-json-formatting
$ easy_install bottle-api-json-formatting
or download the latest version from github::
$ git clone git://github.com/bustleandflurry/bottle-api-json-formatting.git
$ cd bottle-api-json-formatting
$ python setup.py install
Usage
===============
import bottle
import bottle-api-json-formatting
app = bottle.Bottle()
app.install(bottle_api_json_formatting.json_formatting())
@app.route('/')
def index():
return 'This is a test.'
@APP.route('/error')
def index():
raise Exception('This is an error.')
if __name__ == '__main__':
run(app, host='0.0.0.0', port=8080, debug=True)
Output
=============
Standard:
{
"status": "success",
"status_code": 0,
"data": "test"
}
Error:
{
"status": "error",
"status_code": 1,
"data": null,
"error": {
"status": "500 Internal Server Error",
"status_code": 500,
"message": "Internal Server Error"
}
}
Configuration
=============
bottle_api_json_formatting.json_formatting(debug=True)
bottle-api-json-formatting
=====================
A Bottle plugin which encapsulates results and errors in a json object. This
makes it much easier to build REST based api services with bottle.
Installation
===============
Install with one of the following commands::
$ pip install bottle-api-json-formatting
$ easy_install bottle-api-json-formatting
or download the latest version from github::
$ git clone git://github.com/bustleandflurry/bottle-api-json-formatting.git
$ cd bottle-api-json-formatting
$ python setup.py install
Usage
===============
import bottle
import bottle-api-json-formatting
app = bottle.Bottle()
app.install(bottle_api_json_formatting.json_formatting())
@app.route('/')
def index():
return 'This is a test.'
@APP.route('/error')
def index():
raise Exception('This is an error.')
if __name__ == '__main__':
run(app, host='0.0.0.0', port=8080, debug=True)
Output
=============
Standard:
{
"status": "success",
"status_code": 0,
"data": "test"
}
Error:
{
"status": "error",
"status_code": 1,
"data": null,
"error": {
"status": "500 Internal Server Error",
"status_code": 500,
"message": "Internal Server Error"
}
}
Configuration
=============
bottle_api_json_formatting.json_formatting(debug=True)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for bottle-api-json-formatting-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5eb98396b6fed4df0347281971bdd5ca497ab75d6c62d0aa703b54355c65ad5 |
|
MD5 | 4851cbf768a35be5af7a64124a593907 |
|
BLAKE2b-256 | 092708c24aa23d858f7da8e8f5df3705811fd2fc7dd78a1591fb8ada6b2a996e |
Close
Hashes for bottle-api-json-formatting-0.0.5.linux-i686.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a237fb3935a60c57d3f4563e1846154722e6a2fba1f61b28fb218090b071e85d |
|
MD5 | 14c36f27a37265b24085c3e165bf7464 |
|
BLAKE2b-256 | 64f794dd479e05b9a4d5565dab4c1c54d56b450053e6f622c787667f5c167821 |