Skip to main content

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)

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

bottle-api-json-formatting-0.0.7.tar.gz (3.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page