Flask RESTful API开发 资源与资源列表

REST API设计的核心是资源(Resource),围绕着资源才有了URI和各种各样的HTTP操作。
因此,如何对资源建模就显得十分重要,
这关系到API能否为使用者提供他们想要的功能,
以及API的设计是否简明,便于维护

资源和资源列表的URI

资源可以是独立的,比如每个单独的用户user
也可以是一个集合,比如所有的用户users

在用复数表示资源集合时,
可以对整个资源列表进行操作:
GET /users
也可以通过集合下单独个体的ID来获取具体某个资源:
GET /users/{userId}

资源和资源列表的互相嵌套

这种“单个资源”与“资源列表”还可以继续互相嵌套下去,
比如每个用户可能有不止一个账号:
/users/{userId}/accounts/{accountId}

资源和资源列表的建模

在数据建模时,
可以将资源列表对应整个存储该类型资源的表格
单个资源对应表格中的每一行
Flask-SQLAlchemy为例,
定义UserModel对应所有用户的集合,映射整个存储用户的表格

# models/user.py
class UserModel(db.Model):
    __tablename__ = 'users'

    @classmethod
    def find_by_name(cls, id):
        return cls.query.filter_by(id=id).first()

资源和资源列表的定义

如上文所示,
整个资源集合被一同建模,对应底层数据库的一个表格
但如果我们想通过URI对单个资源和资源列表分别进行操作,
GET /users
GET /users/{userId}
最好在使用Flask-SQLAlchemy库进行资源定义时,
对单个资源和资源列表进行分别定义:

# resources/user.py
from flask_restful import Resource
from models.user import UserModel

class User(Resource):
  def get(self, id):
    user = UserModel.find_by_id(id)
      if user:
        return user.json(), 200
     return {'message': 'User not found'}, 404
class UserList(Resource):
  def get(self):
    return {'users': list(map(lambda x: x.json(), UserModel.query.all()))}

用户在使用API时,
既可以对user资源进行操作,
通过提供不同的userId查找对应的用户,
也可以对userList资源(即user的资源列表)进行操作,
返回所有的用户。

但不管是user还是userList
都只与同一个模型:userModel进行交互。
对应到底层数据库也是一样,
都只对table users进行操作,
区别只是返回整个表格,
还是返回特定的某一行。

对资源和资源列表操作的分配

既然对同一种资源,
现在有了“单个资源”与“资源列表”两个并行的资源类,
对资源的各种操作就需要合理地分配到这两个类中。

比如对单个资源的获取,更新和删除
适合放在“单个资源”的资源类下。

资源集合的整体获取,和添加新的资源
适合放在“资源列表”的资源类下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • 22年12月更新:个人网站关停,如果仍旧对旧教程有兴趣参考 Github 的markdown内容[https://...
    tangyefei阅读 35,170评论 22 257
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 转载,觉得这篇写 SQLAlchemy Core,写得非常不错。不过后续他没写SQLAlchemy ORM... ...
    非梦nj阅读 5,385评论 1 14
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,417评论 0 19
  • 今天是开学的第一天,刚刚六点,闹钟还没来得及工作,豪豪就起床了。不知为什么,走出卧室,他傻傻地笑了。 ...
    何佳豪的妈妈阅读 166评论 0 0