flask中Flask-RESTful一快速学习

    Flask-RESTful是flask的扩展,增加了对快速构建REST API的支持。Flask-RESTful通过最少的设置鼓励最佳的实践。

pip install flask-restful
Flask-RESTful需要Python版本2.7,3.4,3.5,3.6或3.7

  1. 资源和路由
    from flask-restful import Resource,Api
    app = Flask(name)
    api = Api(app)
    class TodoSimple(Resource):
    pass
    api.add_resource(TodoSimple, '/<string:todo_id>')

总结:
flask-restful的主要构建块是resource,资源构建在Flask可插入视图(http://flask.pocoo.org/docs/views/)之上,只需在资源上定义方法,即可轻松访问多个HTTP方法。
很多时候,在API中,您的资源会有多个网址。您可以将多个URL传递给Api对象add_resource()的方法上。每一个都将路由传到您的Resource

  1. reqparse模块内置了对请求数据验证的支持 。
    from flask_restful import reqparse
    parser = reqparse.RequestParser()
    parser.add_argument('rate', type=int, help='Rate to charge for this resource')
    args = parser.parse_args()
    注意:与argparse模块不同,reqparse.RequestParser.parse_args() 返回Python字典而不是自定义数据结构。
    使用该reqparse模块还可以免费为您提供合理的错误消息。如果参数未能通过验证,Flask-RESTful将响应400 Bad Request和突出显示错误的响应。

  2. 默认情况下,返回可迭代中的所有字段都将按原样呈现。虽然在处理Python数据结构时这很有用,但在处理对象时会非常令人沮丧。为了解决这个问题,Flask-RESTful提供了fields模块和 marshal_with()装饰器。与Django ORM和WTForm类似,您可以使用该fields模块来描述响应的结构。
    from flask_restful import fields, marshal_with
    @marshal_with
    该 marshal_with()装饰将应用所描述的转变 resource_fields。从对象中提取的唯一字段是task。该 fields.Url字段是一个特殊字段,它采用端点名称并在响应中为该端点生成URL。您需要的许多字段类型已包含在内。

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