如何从Flask API返回JSON响应

2025年1月5日 | 阅读6分钟

在不断发展的 Web 开发领域，构建健壮的 API 是一项关键技能。Flask 是一个轻量级且功能多样的 Python Web 框架，可以轻松创建能够处理各种任务的 API。API 开发的一个基本方面是能够以 JSON（JavaScript 对象表示法）格式返回数据。

JSON 因其简单性和可读性已成为 Web 应用程序中数据交换的事实标准。在本文中，我们将探讨如何从 Flask API 返回 JSON 响应，涵盖关键概念、最佳实践和示例，以帮助您构建高效且可维护的 API。

理解 JSON

在深入研究 Flask 特定细节之前，让我们简要了解一下 JSON 是什么。JSON 是一种轻量级的数据交换格式，人类易于阅读和编写。机器也易于解析和生成。JSON 数据表示为键值对，其中键是字符串，值可以是字符串、数字、对象、数组、布尔值或 null。

这是一个简单的 JSON 对象示例

{
  "name": "John Doe",
  "age": 30,
  "city": "New York",
  "isStudent": false,
  "grades": [85, 92, 78]
}

在 Flask API 的上下文中，以这种 JSON 格式返回数据是一种常见做法。现在，让我们探讨一下如何使用 Flask 来实现这一点。

设置 Flask 应用程序

如果您尚未安装 Flask，可以使用 pip 进行安装

现在，让我们创建一个基本的 Flask 应用程序，其中包含一个返回 JSON 响应的路由

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/api/data', methods=['GET'])
def get_data():
    data = {
        'message': 'Hello, Flask API!',
        'status': 'success'
    }
    return jsonify(data)

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

输出

* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

在此示例中，我们定义了一个响应 HTTP GET 请求的 /api/data 路由。get_data 函数创建一个字典（data），然后使用 Flask 的 jsonify 函数将其作为 JSON 响应返回。

使用 jsonify 进行 JSON 响应

Flask 提供了一个方便的 jsonify 函数，它接受 Python 数据结构（如字典或列表），并将它们转换为 JSON 格式的响应。此函数不仅处理转换，还会在 HTTP 响应中设置适当的 Content-Type 标头。

以下是使用 jsonify 处理复杂数据的更详细示例

from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/api/student', methods=['GET'])
def get_student():
    student = {
        'id': 1,
        'name': 'Alice',
        'grades': {
            'math': 95,
            'history': 88,
            'science': 92
        },
        'courses': ['Mathematics', 'History', 'Science']
    }
    return jsonify(student)

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

输出

{
  "id": 1,
  "name": "Alice",
  "grades": {
    "math": 95,
    "history": 88,
    "science": 92
  },
  "courses": ["Mathematics", "History", "Science"]
}

在此示例中，get_student 函数返回一个 JSON 响应，其中包含有关学生的信息，包括他们的成绩和注册课程。

处理 HTTP 状态码

设计 API 时，提供有意义的 HTTP 状态码以指示请求的成功或失败非常重要。Flask 的 jsonify 函数还可以通过将其作为第一个参数传递来处理状态码。这是一个示例

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/api/success', methods=['GET'])
def success():
    data = {
        'message': 'Operation successful',
        'status': 'success'
    }
    return jsonify(data), 200

@app.route('/api/error', methods=['GET'])
def error():
    error_data = {
        'message': 'Operation failed',
        'status': 'error'
    }
    return jsonify(error_data), 404

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

输出

{
  "message": "Operation successful",
  "status": "success"
}

错误请求 - 输出

{
  "message": "Operation failed",
  "status": "error"
}

在此示例中，/api/success 路由返回一个带有成功消息和 200（OK）状态码的 JSON 响应。另一方面，/api/error 路由返回一个指示错误并带有 404（Not Found）状态码的 JSON 响应。

结构化 JSON 响应

随着 API 复杂性的增加，建立一致的 JSON 响应结构至关重要。这不仅有助于理解和维护代码，还能提高消费您 API 的开发人员的体验。

考虑采用标准的响应结构，包括 status、message 和 data 等字段。这是一个示例

from flask import Flask, jsonify

app = Flask(__name__)

def success_response(data):
    return jsonify({
        'status': 'success',
        'data': data
    }), 200

def error_response(message, status_code):
    return jsonify({
        'status': 'error',
        'message': message
    }), status_code

@app.route('/api/student_info', methods=['GET'])
def get_student_info():
    student = {
        'id': 1,
        'name': 'Bob',
        'grades': {'math': 78, 'history': 90, 'science': 85},
        'courses': ['Mathematics', 'History', 'Science']
    }

    # Returning a success response
    return success_response(student)

@app.route('/api/not_found', methods=['GET'])
def not_found():
    # Returning an error response
    return error_response('Resource not found', 404)

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

在此示例中，定义了 success_response 和 error_response 函数来封装成功和错误响应的通用结构。这促进了代码的可重用性和清晰性。

处理查询参数

在实际场景中，API 通常需要处理查询参数来定制响应。Flask 使用 request 对象可以轻松访问这些参数。这是一个示例

from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/api/greet', methods=['GET'])
def greet_user():
    # Accessing query parameters
    user_name = request.args.get('name', 'Guest')

    data = {
        'message': f'Hello, {user_name}!',
        'status': 'success'
    }
    return jsonify(data)

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

输出

{
  "message": "Hello, John!",
  "status": "success"
}

在此示例中，/api/greet 路由接受一个名为 name 的查询参数，并使用它来定制问候消息。如果未提供 name 参数，则默认值为“Guest”。

处理 POST 请求和请求数据

虽然之前的示例侧重于处理 GET 请求，但 API 通常需要处理 POST 请求体中发送的数据。Flask 提供 request 对象来访问这些数据。这是一个简单的示例

from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/api/post_data', methods=['POST'])
def receive_data():
    # Accessing data from the request body
    request_data = request.json

    if not request_data:
        return jsonify({'message': 'No data provided'}), 400

    # Process the received data (in this case, simply echoing it back)
    return jsonify({'echoed_data': request_data, 'status': 'success'})

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

输出

{
  "echoed_data": {
    "key": "value"
  },
  "status": "success"
}

在此示例中，/api/post_data 路由处理 POST 请求体中的传入 JSON 数据。收到的数据会以响应的形式回显。

错误处理和自定义异常

健壮的 API 包括适当的错误处理，以指导客户端理解和解决问题。Flask 允许您为不同的错误场景定义自定义异常处理程序。这是一个示例

from flask import Flask, jsonify

app = Flask(__name__)

class CustomError(Exception):
    def __init__(self, message, status_code):
        super().__init__(message)
        self.status_code = status_code

# Custom error handler
@app.errorhandler(CustomError)
def handle_custom_error(error):
    response = {
        'status': 'error',
        'message': str(error)
    }
    return jsonify(response), error.status_code

# Route triggering a custom error
@app.route('/api/custom_error', methods=['GET'])
def trigger_custom_error():
    raise CustomError('This is a custom error', 500)

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

输出

{
  "status": "error",
  "message": "This is a custom error"
}

在此示例中，定义了一个自定义异常 CustomError。handle_custom_error 函数被注册为该特定异常的错误处理程序。当访问 /api/custom_error 路由时，它会触发自定义错误，并且会调用自定义错误处理程序，返回一个带有适当状态码的 JSON 响应。

测试您的 Flask API

编写测试是开发过程中至关重要的一部分，可以确保您的 API 按预期运行。Flask 提供了一个测试框架，可以轻松编写路由的单元测试。这是一个基本示例

import unittest
from flask import Flask, jsonify
from your_app_module import app  # Import your Flask app

class FlaskAPITestCase(unittest.TestCase):

    def test_get_data(self):
        with app.test_client() as client:
            response = client.get('/api/data')
            data = response.get_json()

            self.assertEqual(response.status_code, 200)
            self.assertEqual(data['status'], 'success')
            self.assertIn('message', data)

    # Add more test cases for your routes

if __name__ == '__main__':
    unittest.main()

输出

.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK

在此示例中，创建了一个简单的测试用例来检查 /api/data 路由的响应。您可以通过添加更多针对其他路由和场景的测试用例来扩展它。定期运行测试有助于在开发过程早期捕获问题。

结论

构建返回 JSON 响应的 Flask API 是任何 Web 开发人员的一项基本技能。通过利用 Flask 的功能，包括 jsonify 函数、处理查询参数、处理 POST 请求和实现错误处理，您可以创建健壮的 API，为客户端提供无缝的体验。

采用最佳实践，例如一致地构建 JSON 响应和编写单元测试，有助于提高 API 的可维护性和可靠性。随着您继续探索 Flask 和 API 开发，您会发现许多其他功能和优化来进一步提升您的技能。

下一主题Numpy-quantile-in-python

如何从Flask API返回JSON响应

理解 JSON

设置 Flask 应用程序

使用 jsonify 进行 JSON 响应

处理 HTTP 状态码

结构化 JSON 响应

处理查询参数

处理 POST 请求和请求数据

错误处理和自定义异常

测试您的 Flask API

结论

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

其他

如何从Flask API返回JSON响应

理解 JSON

设置 Flask 应用程序

使用 jsonify 进行 JSON 响应

处理 HTTP 状态码

结构化 JSON 响应

处理查询参数

处理 POST 请求和请求数据

错误处理和自定义异常

测试您的 Flask API

结论

相关帖子

从另一个文件中调用Python函数

Python中的Importlib包

Python中的三元图

如何在Python中计算pow(x, n)

Python中的ChromaDB

使用OpenCV-Python进行行人检测

Python - 检查字符串是否匹配正则表达式列表

如何在Python中更改文件扩展名

Amazon SageMaker Python SDK入门

使用 OpenCV 在 Python 中确定面部倾斜

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器