use jsonify instead of json.dumps for JSON output

Docs > Code Analysis > Static Analysis Rules > use jsonify instead of json.dumps for JSON output

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: python-flask/use-jsonify

Language: Python

Severity: Notice

Category: Best Practices

Description

With the flask framework, jsonify helps you write API endpoints that return JSON data.

Learn More

Python Flask: jsonify()

Non-Compliant Code Examples

@app.route("/article")
def get_article():
    article = get_article_by_id(request.args.get("id"))
    return json.dumps(article) # use flask.jsonify instead of json.dumps

Compliant Code Examples

from flask import jsonify

@app.route("/article")
def get_article():
    article = get_article_by_id(request.args.get("id"))
    return jsonify(article)