Skip to main content

Better JSON support for Flask

Project description

https://github.com/skozlovf/flask-json/actions/workflows/test.yml/badge.svg?branch=master

Flask-JSON is a simple extension that adds better JSON support to Flask application.

Features:

  • Works on python 2.6, 2.7, 3.3+ and Flask 0.10+.

  • More ways to generate JSON responses (comparing to plain Flask).

  • Extended JSON encoding support.

Usage

Here is fast example:

from datetime import datetime
from flask import Flask
from flask_json import FlaskJSON, JsonError, json_response, as_json

app = Flask(__name__)
FlaskJSON(app)


@app.route('/get_time')
def get_time():
    return json_response(time=datetime.utcnow())


@app.route('/get_time_and_value')
@as_json
def get_time_and_value():
    return dict(time=datetime.utcnow(), value=12)


@app.route('/raise_error')
def raise_error():
    raise JsonError(description='Example text.', code=123)


if __name__ == '__main__':
    app.run()

Responses:

GET /get_time HTTP/1.1

HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 60

{
  "status": 200,
  "time": "2015-04-14T13:17:16.732000"
}
GET /raise_error HTTP/1.1

HTTP/1.0 400 BAD REQUEST
Content-Type: application/json
Content-Length: 70

{
  "code": 123,
  "description": "Example text.",
  "status": 400
}

Documentation

Documentation is available on Read the Docs.

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

Flask-JSON-0.4.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

Flask_JSON-0.4.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file Flask-JSON-0.4.0.tar.gz.

File metadata

  • Download URL: Flask-JSON-0.4.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for Flask-JSON-0.4.0.tar.gz
Algorithm Hash digest
SHA256 07945d66024f3b77694ce1db5d1fe83940f2aa3bcad8a608535686be67e4bc48
MD5 b3691b9b735ea685f9cba2dea249758c
BLAKE2b-256 ba4a6046e195241772f4b6add3adcd4e820004c6151afc587d8c7d0d4ffeb473

See more details on using hashes here.

Provenance

File details

Details for the file Flask_JSON-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: Flask_JSON-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for Flask_JSON-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c1b87a657daa2179fc19f1ffc78204a716c7c5139673dc5038772db4d9f1988
MD5 19c1b53d9b5e3aa10abde1bafb7148b0
BLAKE2b-256 ae873b3ae3ca23dd90b15faa1128c473c1cf16d42e9f95efc5e4a1b77bf22260

See more details on using hashes here.

Provenance

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