Flask 插件学习系列:Restful

    一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。
本文参考:https://baijiahao.baidu.com/s?id=1572275589970400&wfr=spider&for=pc

  • 1.安装和导包

$ pip install Flask-RESTful

安装完成后就可以在代码中带入拓展包 from flask_restful import

  • 2.不带参数的请求
        resource方法来添加路由,方法的第一个参数是定义的类名,该类需要继承"Resource"基类,其成员函数定义了不同的 HTTP 请求方法的逻辑,如:GET、POST等;第二个参数定义了 URL 路径。
from flask import Flask, request

from flask_restful import Api ,Resource

app = Flask(__name__)

api = Api(app)

USER_LIST = {

'1': {'name':'Michael'},

'2': {'name':'Tom'},

}

class UserList(Resource):

      def get(self):

          return USER_LIST

      def post(self):

          user_id = int(max(USER_LIST.keys)) 

          user_id = '%i' % user_id

          USER_LIST[user_id] = {'name': request.form['name']}

          return USER_LIST[user_id]

api.add_resource(UserList, '/users')

if __name__ == '__main__':
     app.run(host='0.0.0.0', debug=True)
  • 3.带参数的请求
    可以直接在定义类的成员函数下直接添加传递的参数
    示例如下:
class User(Resource):

      def get(self, user_id):
             pass
      def delete(self, user_id):
             pass
      def put(self, user_id):
            pass
api.add_resource(User, '/users/')
  • 4.参数解析
    在 POST 或 PUT 请求中,直接访问 form 表单并验证的工作有些麻烦。Flask-RESTful 提供了"reqparse"库来简化。
from flask_restful import reqparse

parser = reqparse.RequestParser()

parser.add_argument('name', type=str)

args = parser.parse_args()

USER_LIST[user_id] = {'name': args['name']}

上述代码中通过"parser.add.argument"方法来定义 form 表单字段,并指定其类型(本例中是字符型 str)。

然后在 PUT 函数中,就可以调用"parser.parse.args"来获取表单内容,并返回一个字典,该字典就包含了表单的内容。

parser.parse.args"方法会自动验证数据类型,并在类型不匹配时,返回 400 错误。

你还可以添加"strict"参数,如"parser.parse.args(strict=True)",此时如果请求中出现未定义的参数,也会返回 400 错误。

  • 5.示例
from flask import Flask

from flask_restful import Api, Resource, reqparse, abort

USER_LIST = {

'1': {'name':'Michael'},

'2': {'name':'Tom'},

}

def abort_if_not_exist(user_id):

      if user_id not in USER_LIST:

            abort(404, message="User {} doesn't exist".format(user_id))

            abort_if_not_exist(user_id)

            return '', 204

      args = parser.parse_args(strict=True)

      return USER_LIST[user_id], 201

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

推荐阅读更多精彩内容