【flask系列】基于flask的 RESTful API示例

原创 xlwin136 人工智能教学实践

RESTful API（Representational State Transfer Application Programming Interface）是一种基于 REST 架构风格的网络应用程序接口。

REST 是一种设计网络服务的架构风格，它通过使用 HTTP 协议的通用动词（如 GET、POST、PUT、DELETE 等）来允许客户端和服务器之间进行交互。

以下是 RESTful API 的一些核心概念和特点：

一、核心概念：

• 资源（Resources）：网络上的每一个事物都被视为一个资源，每个资源都有一个唯一的标识符（URI）。

• 表现层（Representation）：资源可以有多种表现形式，如 JSON、XML、HTML 等。客户端和服务器通过这些表现形式交换资源的状态。

• 状态转移（State Transfer）：在客户端和服务器之间的交互是无状态的。所有的状态信息都保存在资源本身中，客户端每次请求都需要提供足够的信息来处理该请求。

二、设计原则：

• 客户端-服务器：客户端和服务器是分离的，客户端通过发送请求来操作服务器上的资源。

• 无状态：每次请求都包含了处理该请求所需的所有信息，服务器不会存储任何关于客户端会话的信息。

• 可缓存：服务器响应应该明确表明是否可以被缓存，以优化网络效率。

• 分层系统：系统组件之间是分层的，每一层只知道下一层的信息，不知道更高级别的信息。

• 按需代码（Code on Demand）：服务器可以临时扩展或自定义客户端的功能，例如发送脚本代码给客户端执行。

三、 HTTP 方法：

• GET：检索资源的表示形式。

• POST：创建新的资源或提交数据给服务器。

• PUT：更新资源或替换资源的状态。

• DELETE：删除资源。

• PATCH：部分更新资源。

四、 RESTful API 的特点：

• 统一接口：使用标准的 HTTP 方法，具有自描述的消息（如状态码、媒体类型等）。

• 可寻址性：每个资源都可以通过 URI 定位。

• 可链接性：资源之间通过超链接相互连接。

• 性能：通过缓存和其他机制提高效率。

• 可扩展性：通过分层架构和按需代码，系统易于扩展。

五、示例：

以下是一个简单的 RESTful API 的示例，使用 Flask 框架实现：

from flask import Flask, jsonify, request
app = Flask(__name__)
# 假设我们有一些数据
tasks = [
    {'id': 1, 'title': 'Buy groceries', 'done': False},
    {'id': 2, 'title': 'Read a book', 'done': False}
]
@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({'tasks': tasks})
@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({'error': 'Task not found'}), 404
    return jsonify({'task': task})
@app.route('/tasks', methods=['POST'])
def create_task():
    if not request.json or 'title' not in request.json:
        return jsonify({'error': 'Bad request'}), 400
    task = {
        'id': tasks[-1]['id'] + 1 if tasks else 1,
        'title': request.json['title'],
        'done': False
    }
    tasks.append(task)
    return jsonify({'task': task}), 201
if __name__ == '__main__':
    app.run(debug=True)

这个简单的 API 提供了获取任务列表、获取单个任务、创建新任务的功能。它遵循 RESTful 设计原则，使用 JSON 格式交换数据。