Flask API设计原则 #

一、RESTful原则 #

1.1 REST核心概念 #

概念	说明
资源	使用URL表示资源
方法	使用HTTP方法操作资源
表示	使用JSON/XML表示数据
无状态	每个请求独立完整

1.2 URL设计 #

text

GET    /api/users          # 获取用户列表
GET    /api/users/1        # 获取单个用户
POST   /api/users          # 创建用户
PUT    /api/users/1        # 完整更新用户
PATCH  /api/users/1        # 部分更新用户
DELETE /api/users/1        # 删除用户

二、响应格式 #

2.1 成功响应 #

python

from flask import jsonify

@app.route('/api/users/<int:id>')
def get_user(id):
    user = User.query.get_or_404(id)
    return jsonify({
        'id': user.id,
        'username': user.username,
        'email': user.email
    })

2.2 错误响应 #

python

@app.errorhandler(404)
def not_found(error):
    return jsonify({'error': '资源不存在'}), 404

@app.errorhandler(400)
def bad_request(error):
    return jsonify({'error': '请求参数错误'}), 400

三、状态码使用 #

状态码	说明
200	成功
201	创建成功
204	成功无内容
400	请求错误
401	未认证
403	禁止访问
404	未找到
500	服务器错误

四、下一步 #

接下来让我们学习 Flask-RESTful，了解API扩展！