Flask RESTful API開發(fā) 資源與資源列表

REST API設(shè)計(jì)的核心是資源(Resource)嗤栓,圍繞著資源才有了URI和各種各樣的HTTP操作。
因此,如何對(duì)資源建模就顯得十分重要澜躺,
這關(guān)系到API能否為使用者提供他們想要的功能桩蓉,
以及API的設(shè)計(jì)是否簡(jiǎn)明淋纲,便于維護(hù)

資源和資源列表的URI

資源可以是獨(dú)立的院究,比如每個(gè)單獨(dú)的用戶user洽瞬。
也可以是一個(gè)集合玷或,比如所有的用戶users

在用復(fù)數(shù)表示資源集合時(shí)片任,
可以對(duì)整個(gè)資源列表進(jìn)行操作:
GET /users
也可以通過集合下單獨(dú)個(gè)體的ID來獲取具體某個(gè)資源:
GET /users/{userId}偏友。

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

這種“單個(gè)資源”與“資源列表”還可以繼續(xù)互相嵌套下去,
比如每個(gè)用戶可能有不止一個(gè)賬號(hào):
/users/{userId}/accounts/{accountId}

資源和資源列表的建模

在數(shù)據(jù)建模時(shí)对供,
可以將資源列表對(duì)應(yīng)整個(gè)存儲(chǔ)該類型資源的表格位他,
單個(gè)資源對(duì)應(yīng)表格中的每一行
Flask-SQLAlchemy為例产场,
定義UserModel對(duì)應(yīng)所有用戶的集合鹅髓,映射整個(gè)存儲(chǔ)用戶的表格

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

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

資源和資源列表的定義

如上文所示,
整個(gè)資源集合被一同建模京景,對(duì)應(yīng)底層數(shù)據(jù)庫的一個(gè)表格窿冯。
但如果我們想通過URI對(duì)單個(gè)資源和資源列表分別進(jìn)行操作,
GET /users
GET /users/{userId}
最好在使用Flask-SQLAlchemy庫進(jìn)行資源定義時(shí)确徙,
對(duì)單個(gè)資源和資源列表進(jìn)行分別定義:

# 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時(shí)醒串,
既可以對(duì)user資源進(jìn)行操作,
通過提供不同的userId查找對(duì)應(yīng)的用戶鄙皇,
也可以對(duì)userList資源(即user的資源列表)進(jìn)行操作芜赌,
返回所有的用戶。

但不管是user還是userList伴逸,
都只與同一個(gè)模型:userModel進(jìn)行交互缠沈。
對(duì)應(yīng)到底層數(shù)據(jù)庫也是一樣,
都只對(duì)table users進(jìn)行操作错蝴,
區(qū)別只是返回整個(gè)表格洲愤,
還是返回特定的某一行。

對(duì)資源和資源列表操作的分配

既然對(duì)同一種資源顷锰,
現(xiàn)在有了“單個(gè)資源”與“資源列表”兩個(gè)并行的資源類柬赐,
對(duì)資源的各種操作就需要合理地分配到這兩個(gè)類中。

比如對(duì)單個(gè)資源的獲取馍惹,更新和刪除躺率,
適合放在“單個(gè)資源”的資源類下。

對(duì)資源集合的整體獲取万矾,和添加新的資源悼吱,
適合放在“資源列表”的資源類下。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末良狈,一起剝皮案震驚了整個(gè)濱河市后添,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌薪丁,老刑警劉巖遇西,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件馅精,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡粱檀,警方通過查閱死者的電腦和手機(jī)洲敢,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來茄蚯,“玉大人压彭,你說我怎么就攤上這事∩#” “怎么了壮不?”我有些...
    開封第一講書人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)皱碘。 經(jīng)常有香客問我询一,道長(zhǎng),這世上最難降的妖魔是什么癌椿? 我笑而不...
    開封第一講書人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任健蕊,我火速辦了婚禮,結(jié)果婚禮上如失,老公的妹妹穿的比我還像新娘绊诲。我一直安慰自己,他們只是感情好褪贵,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著抗俄,像睡著了一般脆丁。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上动雹,一...
    開封第一講書人閱讀 51,562評(píng)論 1 305
  • 那天槽卫,我揣著相機(jī)與錄音,去河邊找鬼胰蝠。 笑死歼培,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的茸塞。 我是一名探鬼主播躲庄,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼钾虐!你這毒婦竟也來了噪窘?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤效扫,失蹤者是張志新(化名)和其女友劉穎倔监,沒想到半個(gè)月后直砂,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡浩习,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年静暂,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片谱秽。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡籍嘹,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出弯院,到底是詐尸還是另有隱情辱士,我是刑警寧澤,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布听绳,位于F島的核電站颂碘,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏椅挣。R本人自食惡果不足惜头岔,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望鼠证。 院中可真熱鬧峡竣,春花似錦、人聲如沸量九。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽荠列。三九已至类浪,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間肌似,已是汗流浹背费就。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留川队,地道東北人力细。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像固额,于是被迫代替她去往敵國和親眠蚂。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • 22年12月更新:個(gè)人網(wǎng)站關(guān)停对雪,如果仍舊對(duì)舊教程有興趣參考 Github 的markdown內(nèi)容[https://...
    tangyefei閱讀 35,182評(píng)論 22 257
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理河狐,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,657評(píng)論 18 139
  • 轉(zhuǎn)載馋艺,覺得這篇寫 SQLAlchemy Core栅干,寫得非常不錯(cuò)。不過后續(xù)他沒寫SQLAlchemy ORM... ...
    非夢(mèng)nj閱讀 5,412評(píng)論 1 14
  • 一說到REST捐祠,我想大家的第一反應(yīng)就是“啊碱鳞,就是那種前后臺(tái)通信方式□庵”但是在要求詳細(xì)講述它所提出的各個(gè)約束窿给,以及如...
    時(shí)待吾閱讀 3,430評(píng)論 0 19
  • 今天是開學(xué)的第一天,剛剛六點(diǎn)率拒,鬧鐘還沒來得及工作面氓,豪豪就起床了玉工。不知為什么痊班,走出臥室答毫,他傻傻地笑了。 ...
    何佳豪的媽媽閱讀 167評(píng)論 0 0