Flask如何设计RESTful API_Flask-RESTful扩展Resource类设计

酷伟酱_9320

酷伟酱_9320

2026-04-13

781人浏览

原创

flask-restful的resource类需显式实现对应http动词的方法(如get、post),路径参数直接作为方法参数,查询参数须用reqparse或request.args获取;禁用可变类变量,错误响应应统一json格式而非abort()。

flask如何设计restful api_flask-restful扩展resource类设计

Resource类必须继承并实现HTTP方法对应的方法名

Flask-RESTful的Resource类本质是把HTTP动词映射成同名Python方法:你定义get(),它才响应GET;没写post(),POST请求直接405。不是靠装饰器或配置自动绑定。

  • 常见错误:只写了def get(self),但想用PUT更新,结果返回Method Not Allowed
  • 所有支持的动词都得显式写出方法体,哪怕只是return {"msg": "not implemented"}
  • 方法签名不能加额外必填参数——def get(self, user_id)可以(由URL参数传入),但def get(self, token)不行,除非token来自reqparse或request.args

URL参数和查询参数要分清来源和校验方式

路径里的变量(如/users/<user_id></user_id>)在get(self, user_id)里直接当函数参数;而?page=2&sort=name这种得从request.args或reqparse.RequestParser取——混用会导致参数丢失或类型错误。

头条号
头条号

头条号是一款AI文本写作工具,字节跳动推出的内容创作平台。

下载
  • 用reqparse更安全:它能强制类型转换、设默认值、报错提示,比如parser.add_argument("page", type=int, default=1, location="args")
  • 别在get(self, user_id)里再手动调request.args.get("user_id")——路径参数已由Flask路由解析好,重复取可能覆盖或类型错乱
  • location="json"适用于POST/PUT请求体,但前提是客户端发的是Content-Type: application/json,否则reqparse收不到数据

Resource类实例不共享状态,但类变量会跨请求污染

Resource每次请求都会新建实例,所以self.xxx是安全的;但如果你不小心在类定义里写了cache = {},这个字典会在所有请求间共享,导致数据串扰或内存泄漏。

  • 典型踩坑:在class UserResource(Resource): cache = {}里缓存用户数据,结果A用户删了记录,B用户还读到旧缓存
  • 正确做法:用functools.lru_cache装饰函数,或依赖外部缓存(Redis)、或每次在get()里新建临时结构
  • 数据库连接、配置对象这些“只读”类变量可以放类上,但带状态的容器(list/dict/set)一律禁止声明为类属性

错误处理别只靠abort(),要统一响应格式

abort(404)会中断流程并返回纯文本,和你用return {"error": "not found"}不一致。前端要统一解析JSON,就得让所有错误也走return + 状态码。

  • 推荐方式:自定义异常类 + api.error_handlers,比如api.handle_error(UserNotFound)返回{"error": "user not found"}和404
  • 别在每个get()里写if not user: return {"error": "..."}, 404——重复逻辑多,漏写状态码是高频bug
  • abort()适合调试时快速中断,上线前应替换为结构化返回,尤其涉及400/401/422等业务错误时
事情说清了就结束。最常被忽略的是类变量缓存和错误响应格式不统一——这两个点在线上环境出问题时最难排查。

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

相关文章

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

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

下载

相关标签:

restful api

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2989

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2248

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1138

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2078

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3300

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14735

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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