Python 開發(fā)簡單的 web API

本文首發(fā)于我的個人博客 Sui Xin’s Blog
原文:https://suixinblog.cn/2019/09/flask.html
作者:Sui Xin

Flask 是一個簡單的 Python web 框架洛波,使用它只用幾行代碼就可以實現(xiàn)一個小型 Python web 服務绳军。
最近模型與前端整合的時候剛好用到,遂記錄一下它的用法礼预。

一個簡單的小例子

from flask import Flask
app = Flask(__name__)


@app.route("/")
def welcome():
    return "Hello World!"


if __name__ == "__main__":
    app.run()

運行之后訪問 5000 端口即可看到結(jié)果墨闲。

Flask hello world

基本參數(shù)設置

設置 URL 及請求方式

Flask.route(rule, methods=["GET"])

  • rule:指定的 URL。
  • methods:允許的請求方式,默認只響應 GET 請求曹质。

解析 GET 請求參數(shù)

解析 GET 參數(shù)有兩種方式,第二種較為靈活,更推薦第二種使用方式羽德。

第一種:變量轉(zhuǎn)換

@app.route("/user/<string:user_name>")
def welcome(user_name):
    return "Hello {}".format(user_name)
@app.route("/user/<int:id>")
def welcome(id):
    return "Here is No.{}".format(id)

目前支持的轉(zhuǎn)換類型有 string几莽,intfloat 等。使用局限性較大宅静。

第二種:從 URL 中解析

from flask import Flask, request
app = Flask(__name__)


@app.route("/search")
def compute():
    # 假設發(fā)送的請求鏈接為 http://localhost:5000/search?a=2&b=3
    # 可通過 request 來得到參數(shù)
    a = request.args.get("a")
    b = request.args.get("b")
    
    res = int(a) + int(b)
    return res

解析 POST 請求參數(shù)

from flask import Flask, request, jsonify
app = Falsk(__name__)


@app.route("/compute", methods=["POST"])
def compute():
    # 這里客戶端發(fā)送的請求數(shù)據(jù)類似于 {"number": 2}
    json_data = request.json
    number = json_data["number"]
    
    result = number ** 2
    return jsonify(res=result)

返回 json 數(shù)據(jù)

除了直接使用 Python 內(nèi)置的 dict 構(gòu)建 json 格式數(shù)據(jù)返回之外章蚣,還可以使用 flask.jsonify 返回 json 類數(shù)據(jù)。

from flask import Flask, request, jsonify
app = Flask(__name__)


@app.route("/search")
def compute():
    a = request.args.get("a")
    b = request.args.get("b")
    res = int(a) + int(b)
    
    return jsonify(a=a, b=b, res=res)
    # 或者
    # return jsonify({"a": a, "b": b, "res": res})

配置鏈接與端口

app.run(host="localhost", port=5000, debug=True)

host 設置為 0.0.0.0 可使用外網(wǎng)訪問姨夹。

當然纤垂,Flask 可以實現(xiàn)標準的 RESTful API,也能實現(xiàn)更復雜的功能磷账,如捕獲異常等峭沦,甚至可以真正的與數(shù)據(jù)庫打通構(gòu)建更復雜的功能,但這已超出了本文的范圍逃糟,有需要請移步 Flask User’s Guide吼鱼。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市绰咽,隨后出現(xiàn)的幾起案子菇肃,更是在濱河造成了極大的恐慌,老刑警劉巖取募,帶你破解...
    沈念sama閱讀 217,509評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件巷送,死亡現(xiàn)場離奇詭異,居然都是意外死亡矛辕,警方通過查閱死者的電腦和手機笑跛,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評論 3 394
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來聊品,“玉大人飞蹂,你說我怎么就攤上這事》” “怎么了陈哑?”我有些...
    開封第一講書人閱讀 163,875評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長伸眶。 經(jīng)常有香客問我惊窖,道長,這世上最難降的妖魔是什么厘贼? 我笑而不...
    開封第一講書人閱讀 58,441評論 1 293
  • 正文 為了忘掉前任界酒,我火速辦了婚禮,結(jié)果婚禮上嘴秸,老公的妹妹穿的比我還像新娘毁欣。我一直安慰自己庇谆,他們只是感情好,可當我...
    茶點故事閱讀 67,488評論 6 392
  • 文/花漫 我一把揭開白布凭疮。 她就那樣靜靜地躺著饭耳,像睡著了一般。 火紅的嫁衣襯著肌膚如雪执解。 梳的紋絲不亂的頭發(fā)上寞肖,一...
    開封第一講書人閱讀 51,365評論 1 302
  • 那天,我揣著相機與錄音衰腌,去河邊找鬼新蟆。 笑死,一個胖子當著我的面吹牛桶唐,可吹牛的內(nèi)容都是我干的栅葡。 我是一名探鬼主播,決...
    沈念sama閱讀 40,190評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼尤泽,長吁一口氣:“原來是場噩夢啊……” “哼欣簇!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起坯约,我...
    開封第一講書人閱讀 39,062評論 0 276
  • 序言:老撾萬榮一對情侶失蹤熊咽,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后闹丐,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體横殴,經(jīng)...
    沈念sama閱讀 45,500評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,706評論 3 335
  • 正文 我和宋清朗相戀三年卿拴,在試婚紗的時候發(fā)現(xiàn)自己被綠了衫仑。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,834評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡堕花,死狀恐怖文狱,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情缘挽,我是刑警寧澤瞄崇,帶...
    沈念sama閱讀 35,559評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站壕曼,受9級特大地震影響苏研,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜腮郊,卻給世界環(huán)境...
    茶點故事閱讀 41,167評論 3 328
  • 文/蒙蒙 一摹蘑、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧伴榔,春花似錦纹蝴、人聲如沸庄萎。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至援奢,卻和暖如春兼犯,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背集漾。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評論 1 269
  • 我被黑心中介騙來泰國打工切黔, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人具篇。 一個月前我還...
    沈念sama閱讀 47,958評論 2 370
  • 正文 我出身青樓纬霞,卻偏偏與公主長得像,于是被迫代替她去往敵國和親驱显。 傳聞我的和親對象是個殘疾皇子诗芜,可洞房花燭夜當晚...
    茶點故事閱讀 44,779評論 2 354