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
Close
Hashes for bottle-api-json-formatting-0.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3eb2ea281f5a398795055b6e7de55e2ed59aa880149eb414e581a747b096dd0 |
|
MD5 | f9789dd327a465428d21c64a8138bb68 |
|
BLAKE2b-256 | e829ef84f348f25ad5966bbc49deca7f6e13c06c58313cf4ad77624dedf08d65 |