Flask怎么使用Flask-RESTful扩展写接口

风磊吖_8330

风磊吖_8330

2026-09-26

543人浏览

原创

flask-restful 是专为简化 rest api 开发而设计的扩展,它自动处理请求解析、方法分发、状态码与错误响应,开发者只需专注业务逻辑;需注意 api 必须在 flask app 创建后绑定、resource 方法名严格对应 http 动词、requestparser 参数须在类定义期注册、返回值应直接用字典而非 jsonify 封装。

flask怎么使用flask-restful扩展写接口

Flask-RESTful 不是“在 Flask 里写接口的另一种方式”,而是**把重复的请求解析、方法分发、状态码返回、错误响应结构这些事全收走之后,你只管写业务逻辑**。直接上手就行,但得避开几个真实踩过的坑。

初始化 Api 实例必须绑定到 Flask app 对象

常见错误是先创建 Api,再创建 app,或者把 Api(app) 放在模块末尾却忘了执行顺序。结果运行时报 RuntimeError: working outside of application context。

正确做法:

  • app = Flask(__name__) 必须在 Api(app) 之前
  • 不要在函数里临时创建 Api 实例(比如写在某个路由函数里)
  • 如果用工厂模式,Api 要延迟绑定:先 api = Api(),等 create_app() 里拿到 app 后再调用 api.init_app(app)

Resource 类里的方法名必须严格对应 HTTP 动词

get、post、put、delete 这些方法名不能拼错,也不能加下划线(比如 get_user),否则 Flask-RESTful 根本不会调用它,而是返回 405 Method Not Allowed。

注意点:

Flask 3.0.2
Flask 3.0.2

Flask 3.0.2 是 Flask 的官方历史稳定版本,下载地址使用 PyPI wheel 包直链,适合指定版本安装和项目环境复现。

下载
  • 路径参数(如 /users/<user_id></user_id>)会自动作为方法参数传入,类型转换失败时直接 404,不是 400
  • 没定义 post 却访问 POST /users,就是 405;但如果你写了 post 却没处理 JSON body,request.get_json() 可能返回 None,得自己判空
  • options 方法默认不启用,要支持 CORS 预检,得手动实现或配 flask-cors

reqparse.RequestParser 的 add_argument 必须在类定义期完成

新手常把 self.parser.add_argument(...) 放在 __init__ 或某个方法里,结果每次请求都新建 parser,但 parse_args() 实际调用的是类属性上的 parser —— 如果没提前注册参数,就会报 KeyError 或静默忽略字段。

安全写法:

  • 用类变量定义 parser:parser = reqparse.RequestParser(),然后直接在类体里 add_argument
  • 避免在实例方法里反复调用 add_argument,它不是线程安全的
  • type=str 不等于“接受任意字符串”,遇到空值或非字符串类型(如 "null")可能抛异常,建议加 nullable=True 或用自定义 type 函数兜底

返回值格式和状态码别依赖 jsonify 手动包装

Flask-RESTful 允许你直接 return 字典、列表、字符串,它会自动转成 JSON 响应;但如果你混用 jsonify,就容易出现双层封装(比如 {"message": "ok"} 变成 {"message": "ok", "data": {...}})或者状态码被覆盖。

典型问题:

  • return jsonify({...}), 201 是合法的,但不如直接 return {...}, 201 清晰
  • 想返回空响应(如 DELETE 成功),用 return '', 204,别 return jsonify({}),后者是 200 + 空对象
  • 自定义错误响应(如用户不存在),优先用 abort(404, message="User not found"),它比手动 return jsonify(...), 404 更统一,也兼容全局 error handler
最常被忽略的一点:reqparse.RequestParser 在 0.3.9 版本里默认不校验缺失字段是否为空字符串,required=True 只防 key 不存在,不防 "username": ""。真要强校验,得额外加 help + 自定义 type 函数,或者换 marshmallow 做 schema 层校验。

相关文章

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

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

下载

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

相关专题

更多
flask框架如何搭建
flask框架如何搭建

搭建步骤:1、安装Python和Pip;2、创建虚拟环境;3、安装Flask;4、创建Flask应用;5、运行应用;6、访问应用。想了解更多flask框架的相关内容,可以阅读本专题下面的文章。

2024.06.27

2995

8

Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

2025.08.25

4464

10

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

2025.12.15

276

16

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

80

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

40

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

20

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

20

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

40

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

40

19

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Flask-Migrate数据库迁移文档
Flask-Migrate数据库迁移文档

共0课时 | 0人学习

Flask官方快速入门文档
Flask官方快速入门文档

共0课时 | 0人学习