Python开发之路系列:RESTful 接口开发

这篇文章我们来看看在Flask里是如何进行RESTful接口开发的

按照我个人的理解,RESTful的核心价值再与它的规范性。
RESTful接口是面向资源的, 而不是面向动作。

比如一个查书的接口,如果是面向动作的风格,可能是这样的:
/getBook?name=?...
这很好,一目了然。
但是在增加书,修改书,删除书就是这样了:
/addBook
/editBook
/deleteBook
和你对接的前端同事也许会记住这些名字,但是也有可能记错
比如 /deleteBook 记成 /delBook
如果记性好,也没关系,才四个接口。
但是如果对数学书写一些接口呢? 烹饪书呢?你可能会看到这些接口:

/getCookBook
/get-cook-book
/getMathBook
/get-math-book
/getMathematicsBook
/addCookBook
/addRecipe
/edit-a-cook-book
/search-meth-book
/delete-a-math-book
/delmathbook
......  // 无尽的痛苦

或者是由于某些原因后台可能会改这些接口名,导致前后端不一致,增加沟通成本,浪费时间
随着资源增多(除了书你还有其他资源),接口数量成倍增长,如果没有一种统一风格,可以想象接口是多么混乱。
而使用了RESTful风格接口,接口应该是这样的:

/api/v1/books/math/       [GET,PUT,POST,DELETE]
/api/v1/books/cook/       [GET,PUT,POST,DELETE]

自解释并且优雅。

扯的太远了,还是那句话,不了解RESTful风格的通知请面壁然后去百度。
咱们看看怎么用Flask来实现一个最简单的RESTful接口

新建脚本 book.py

from flask import Flask
from flask import request # 导入request对象

book_app = Flask(__name__)


@book_app.route('/books' , methods = ['GET','POST'])   # 这个函数允许GET和POST,其他动作不允许
def book_interface():
    if request.method == 'GET':  # 判断动作
        return 'get a book'
    if request.method == 'POST':
        return 'POST'

if __name__ == '__main__':
    book_app.run(host='0.0.0.0', port=27016, debug='true')

其实这种代码的缺点在于判断分支多,缺乏可读性。因为HTTP动词常用得上的大概有5种:GET POST PUT DELETE PATCH。

下面我们来看一下如果是使用flask提供的restful包是怎样写的

cat.py

from flask import Flask
from flask_restful import Resource, Api

cat_app = Flask(__name__)  # 初始化Flask对象
cat_api = Api(cat_app)          # 初始化Api对象 


class Cat(Resource):
    def get(self, cat_id):    # GET方法
            return 'get a cat %s:' % cat_id
    def post(self):    # POST方法
        return 'post a cat'

cat_api.add_resource(Cat, '/cats/<string:cat_id>')   # 将Cat资源注册

if __name__ == '__main__':
    cat_app.run(host='0.0.0.0', port=27016, debug='true')

显然这样的写法更加优雅。
将RESTful资源添加到蓝图中:

from flask import Blueprint
from flask_restful import Resource, Api

cat_blueprint = Blueprint('cats', __name__)  # 用Blueprint构造函数替代Flask构造函数
cat_api = Api(cat_blueprint)


class Cat(Resource):
    def get(self, cat_id):
            return 'get a cat %s:' % cat_id

    def post(self):
        return 'post a cat'

cat_api.add_resource(Cat, '/cats/<string:cat_id>')

然后在app包的init脚本里导入cat_blueprint并注册就OK了:

_ init _.py:

from cat import cat_blueprint
from flask import Flask
app = Flask(__name__)
app.register_blueprint(cat_blueprint, url_prefix='/api/v3')

总结: 到目前为止的Python系列文章,我们可以总结一些Python和Flask的特点:

  1. 可以导入任何东西,变量、函数、类 都可以。
  2. 到目前为止没有写过一行配置代码。而使用Spring的时候,至少得花时间去维护你的Pom.xml
  3. Flask只提供最小模块。当你想用restful的时候,Flask只是提供了一种类的写法而已,至于SQL ORM这些你需要自己去找其他包来搞定。而SpringBoot提供了Spring Data JPA:从HTTP请求到ORM完成增删改查的整套体系。

下一篇文章我们来学习Python里比较流行的ORM: SQLAlchemy

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

推荐阅读更多精彩内容