Flask RESTful API開發(fā) 更好的項目結構

Flask是一個輕便的Web開發(fā)庫召锈,
但隨著API開發(fā)但進行位仁,越來越多的部分被加入到項目中,
為了結構的簡明和日后的可維護性计贰,
更好地組織項目結構勢在必行。

RESTful API項目目錄結構參考

本文仍然聚焦在REST API設計蒂窒,
因此templating等部分不會涉及躁倒。

|--<項目名稱>
  |--app/
    |--models/
    |--resources/
  |--tests/
  |--venv/
  |--requirements.txt
  |--config.py
  |--run.py

最核心的兩個目錄:

app/ 下存放應用程序代碼,
分為模型和資源兩個部分洒琢。
具體可以參考資源類和模型類秧秉。

tests/下存放單元測試代碼。

開發(fā)環(huán)境的設置:

一個較好的Python開發(fā)習慣是為每個項目建立單獨的虛擬環(huán)境衰抑,
這樣就可以隔離它們之間的Python運行環(huán)境象迎。
在項目目錄下使用virtulenv:
virtualenv --no-site-packages venv
將會自動創(chuàng)建venv目錄,
參數(shù)--no-site-packages強制不將已經安裝到Python系統(tǒng)內的任何第三方包復制過來呛踊,
使得新的venv完全純凈砾淌。

同時,應該將所有的依賴包歸納入requirements.txt谭网,
使得任何使用者可以快速地在任何機器上部署相同的開發(fā)環(huán)境:
$ pip install -r requirements.txt

run.py

run.py用于配置并啟動開發(fā)服務器汪厨。

應該實現(xiàn)的的功能有:

  • 創(chuàng)建應用(app)
  • 實例化flask_restful.Api
  • 綁定資源與URI
  • 連接數(shù)據(jù)庫
# run.py
from flask import Flask
from flask_restful import Api
# 導入各資源類
from resources.user import User, UserList
from resources.item import Item, ItemList

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///data.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
api = Api(app)

@app.before_first_request
def create_tables():
    db.create_all()

api.add_resource(User, '/user/<string:name>')
api.add_resource(UserList, '/users')
api.add_resource(Item, '/item/<string:name>')
api.add_resource(ItemList, '/items')

if __name__ == '__main__':
    from db import db
    db.init_app(app)
    app.run(port=5000, debug=True)

綁定資源與URI

在使用Flask-RESTful輔助開發(fā)時,
由于不再直接綁定URI和視圖函數(shù)蜻底,
而是單獨定義各個資源類骄崩,再綁定資源類與URI,
因此在run.py中集中進行綁定是一個較好的實踐薄辅。

連接數(shù)據(jù)庫

在模型類中我們使用ORM技術將模型與數(shù)據(jù)庫中的表一一對應要拂,
但ORM并不會自動為我們創(chuàng)建數(shù)據(jù)庫,
如果試圖連接并不存在的數(shù)據(jù)庫顯然會產生ERROR站楚。

為了創(chuàng)建初始數(shù)據(jù)庫以供鏈接脱惰,
可以使用:

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()
db.create_all()

將其放入單獨的腳本,在API應用啟動前運行創(chuàng)建數(shù)據(jù)庫即可窿春。

但還有一個更好的方法:
app.before_first_request裝飾器允許我們定義一個函數(shù)拉一,
并且這個函數(shù)將在第一個請求到來之前運行采盒。

因此

@app.before_first_request
def create_tables():
    db.create_all()

可以完美替代額外的腳本,簡化了流程蔚润。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末磅氨,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子嫡纠,更是在濱河造成了極大的恐慌烦租,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,204評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件除盏,死亡現(xiàn)場離奇詭異叉橱,居然都是意外死亡,警方通過查閱死者的電腦和手機者蠕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,091評論 3 395
  • 文/潘曉璐 我一進店門窃祝,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人踱侣,你說我怎么就攤上這事粪小。” “怎么了泻仙?”我有些...
    開封第一講書人閱讀 164,548評論 0 354
  • 文/不壞的土叔 我叫張陵糕再,是天一觀的道長。 經常有香客問我玉转,道長突想,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,657評論 1 293
  • 正文 為了忘掉前任究抓,我火速辦了婚禮猾担,結果婚禮上,老公的妹妹穿的比我還像新娘刺下。我一直安慰自己绑嘹,他們只是感情好,可當我...
    茶點故事閱讀 67,689評論 6 392
  • 文/花漫 我一把揭開白布橘茉。 她就那樣靜靜地躺著工腋,像睡著了一般。 火紅的嫁衣襯著肌膚如雪畅卓。 梳的紋絲不亂的頭發(fā)上擅腰,一...
    開封第一講書人閱讀 51,554評論 1 305
  • 那天,我揣著相機與錄音翁潘,去河邊找鬼趁冈。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的渗勘。 我是一名探鬼主播沐绒,決...
    沈念sama閱讀 40,302評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼旺坠!你這毒婦竟也來了乔遮?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,216評論 0 276
  • 序言:老撾萬榮一對情侶失蹤价淌,失蹤者是張志新(化名)和其女友劉穎申眼,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蝉衣,經...
    沈念sama閱讀 45,661評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,851評論 3 336
  • 正文 我和宋清朗相戀三年巷蚪,在試婚紗的時候發(fā)現(xiàn)自己被綠了病毡。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,977評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡屁柏,死狀恐怖啦膜,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情淌喻,我是刑警寧澤僧家,帶...
    沈念sama閱讀 35,697評論 5 347
  • 正文 年R本政府宣布,位于F島的核電站裸删,受9級特大地震影響八拱,放射性物質發(fā)生泄漏。R本人自食惡果不足惜涯塔,卻給世界環(huán)境...
    茶點故事閱讀 41,306評論 3 330
  • 文/蒙蒙 一肌稻、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧匕荸,春花似錦爹谭、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,898評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至践惑,卻和暖如春腹泌,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背童本。 一陣腳步聲響...
    開封第一講書人閱讀 33,019評論 1 270
  • 我被黑心中介騙來泰國打工真屯, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人穷娱。 一個月前我還...
    沈念sama閱讀 48,138評論 3 370
  • 正文 我出身青樓绑蔫,卻偏偏與公主長得像运沦,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子配深,可洞房花燭夜當晚...
    茶點故事閱讀 44,927評論 2 355

推薦閱讀更多精彩內容

  • 22年12月更新:個人網(wǎng)站關停携添,如果仍舊對舊教程有興趣參考 Github 的markdown內容[https://...
    tangyefei閱讀 35,182評論 22 257
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn)篓叶,斷路器烈掠,智...
    卡卡羅2017閱讀 134,657評論 18 139
  • # Python 資源大全中文版 我想很多程序員應該記得 GitHub 上有一個 Awesome - XXX 系列...
    aimaile閱讀 26,482評論 6 427
  • 今天寫分享稿的時候就在想左敌,在虛舟老師的21天反思訓練營中我究竟學到了什么,為什么值得我去跟我所有復盤群的小伙伴推廣...
    君小曉閱讀 497評論 6 6
  • 12月26日星期一俐镐,二期家人們早上好 (2營) 看過《射雕英雄傳》的人都知道郭靖很蠢矫限,資質很差∨迥ǎ可就是這么一個笨...
    純潔的小肥鴨閱讀 161評論 0 0