Python后端开发中如何使用Flask快速搭建RESTful API规范接口?

大瑶吖_2090

大瑶吖_2090

2026-11-09

906人浏览

原创

直接用 Flask 原生路由 + jsonify 即可构建规范 RESTful API,无需已停维护的 Flask-RESTful;应遵循“资源即 URL”原则,如 /users 和 /users/,按 HTTP 方法区分操作,禁用动作式路径;参数解析须显式调用 request.get_json() 并手动校验;统一响应格式需自定义 api_response 函数。

python后端开发中如何使用flask快速搭建restful api规范接口?

直接用 Flask 原生路由 + jsonify 就能快速搭出符合规范的 RESTful API,不需要 Flask-RESTful——它已停止维护,且在 Flask 2.3+ 和 Werkzeug 2.3+ 下容易触发 BadRequestKeyError 或 I/O operation on closed file 错误。

用原生路由定义资源路径和 HTTP 方法

RESTful 的核心是“资源即 URL”,不是动词拼接。比如用户资源统一用 /users 和 /users/,靠方法区分行为:

  • GET /users → 返回用户列表,状态码 200
  • POST /users → 创建用户,成功返回新对象 + 201
  • GET /users/ → 单个用户,不存在时返回 404
  • PUT /users/ → 全量更新,要求客户端传完整字段
  • DELETE /users/ → 删除,成功返回空响应 + 204

不要写 /getUserById 或 /deleteUser 这类动作式路径——它破坏资源抽象,后期难维护、难文档化、前端调用易混淆。

参数解析必须显式用 request.get_json(),别碰 reqparse

Flask-RESTful 的 reqparse 模块默认尝试从 form 和 json 两个位置读取,但现代 API 几乎只收 JSON;不指定 location='json' 就会因 Content-Type 不匹配或空体直接抛 400,且错误信息不明确。

更稳妥的做法是:

  • 统一用 request.get_json(silent=True) 或 request.get_json(force=True)(后者跳过 MIME 类型检查)
  • 手动校验字段是否存在、类型是否合法,比如:if not data or 'name' not in data:
  • 避免混用 request.json 和 reqparse.parse_args() ——前者会提前读取并关闭请求流,导致后者报 I/O operation on closed file

示例片段:

@app.route('/users', methods=['POST'])
def create_user():
    data = request.get_json(silent=True)
    if not data or not isinstance(data, dict):
        return jsonify({'error': 'Invalid JSON'}), 400
    if 'name' not in data or not isinstance(data['name'], str):
        return jsonify({'error': 'Missing or invalid name'}), 400
    # ... 创建逻辑
    return jsonify(new_user), 201

统一响应格式和错误处理要自己控制,别依赖框架自动返回

Flask 默认的 404/500 页面是 HTML,jsonify 又不自动带状态语义,前端很难做一致判断。建议封装一个响应函数:

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
def api_response(data=None, message='', status=200):
    success = 200 <p>然后所有接口都走这个出口,包括错误分支:</p>
  • 查不到用户 → api_response(message='User not found', status=404)
  • 数据库异常 → api_response(message='Internal error', status=500)
  • 参数校验失败 → api_response(message='Name is required', status=400)

注意:不要用 abort(404) 或全局 @app.errorhandler 替代——它们无法携带自定义字段,且容易绕过你的统一结构。

开发期用 debug=True,但上线前必须关掉

app.run(debug=True) 会启用 Werkzeug 的交互式调试器,暴露完整 traceback,线上等于把源码和环境变量直接送给攻击者。

正确做法是:

  • 开发时用 FLASK_ENV=development flask run(Flask 2.0+ 推荐方式)
  • 生产部署用 WSGI 服务器(如 Gunicorn + Nginx),禁用 debug 和 use_reloader
  • 通过配置文件区分环境,比如 config.py 中定义 DEBUG = os.getenv('FLASK_DEBUG', 'false').lower() == 'true'

另外,debug=True 会忽略某些异常捕获逻辑,导致本地能跑通、线上直接 500,这点很容易被忽略。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2903

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

7230

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6786

10

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1891

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5224

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1829

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

31557

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3727

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3747

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程