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

风磊吖_8330

风磊吖_8330

2026-09-26

583人浏览

原创

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。

注意点:

  • 路径参数(如 /users/)会自动作为方法参数传入,类型转换失败时直接 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 或静默忽略字段。

python-flask-vue-creator
python-flask-vue-creator

创建 Flask + Vue.js 全栈项目,采用单端口架构、uv 依赖管理、结构化日志和生产级前端设计。当用户要求以下操作时触发:创建新的 Flask+Vue 项目、搭建 Web 应用、构建全栈 Python+Vue 应用、初始化 Flask Web 项目、设置单端口 Flask 前后端项目。触发词:新建项目、创建项目、搭建项目、Flask项目、Vue项目。

下载

安全写法:

  • 用类变量定义 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

4515

8

Python Flask框架
Python Flask框架

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

2025.08.25

7024

10

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

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

2025.12.15

336

16

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

0

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

20

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

0

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

0

10

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

2026.11.17

0

11

SQLAlchemy ORM 模型怎么写
SQLAlchemy ORM 模型怎么写

SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。

2026.11.17

0

16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习