使用Flask-RESTful 设计 RESTful API

restful

Flask-RESTful 提供了一个Resource基础类,能够定义一个给定URL的一个或者多个HTTP方法。


上一篇TODO list应用改用Flask_RESTful的完整示例代码:

from flask import Flask, abort, url_for, make_response, jsonify
from flask_restful import Resource, Api, reqparse, fields, marshal
from flask_httpauth import HTTPBasicAuth

app = Flask(__name__)
api = Api(app)
auth = HTTPBasicAuth()

tasks = [
    {
        'id':1,
        'title':'白鹿原',
        'description':'这是一定死啦塞啊;阿凯骄傲灵丹安矿鉴定暗访东方三;啊反馈;安静快撒娇扥卡机',
        'done':False
    },
    {
        'id':2,
        'title':'嫌疑人',
        'description':'as大肯借;额看课文静安寺放大反抗航将;来否;付定金奥兰多 看企鹅长恨东澳岛啊;伐开森',
        'done':False
    }
]

task_fields = {
    'title': fields.String,
    'description': fields.String,
    'done': fields.Boolean,
    'uri': fields.Url('task')
}

class TaskListAPI(Resource):
    decorators = [auth.login_required]
    def __init__(self):
        self.reqparse = reqparse.RequestParser()
        self.reqparse.add_argument('title', type=str, required=True,
            help='No task title provided', location='json')
        self.reqparse.add_argument('description', type=str, default="", 
            location='json')
        self.reqparse.add_argument('done', type=bool, location='json')
        super(TaskListAPI, self).__init__()

    def get(self):
        return jsonify(list(map(marshal, tasks, [task_fields for i in range(len(tasks))])))

    def post(self):
        task = {}
        args = self.reqparse.parse_args()
        task['id'] = tasks[-1]['id']+1
        for k, v in args.items():
            if v != None:
                task[k] = v
        tasks.append(task)
        return {'task':task}, 201

class TaskAPI(Resource):
    decorators = [auth.login_required]
    def __init__(self):
        self.reqparse = reqparse.RequestParser()
        self.reqparse.add_argument('title', type=str, location='json')
        self.reqparse.add_argument('description', type=str, location='json')
        self.reqparse.add_argument('done', type=bool, location='json')
        super(TaskAPI, self).__init__()

    def get(self, id):
        task = list(filter(lambda x: x['id']==id, tasks))
        if len(task)==0:
            abort(404)
        task = task[0]
        return {'task': marshal(task, task_fields)}

    def put(self, id):
        task = list(filter(lambda t: t['id'] == id, tasks))
        if len(task) == 0:
            abort(404)
        task = task[0]
        args = self.reqparse.parse_args()
        for k, v in args.items():
            if v != None:
                task[k] = v
        # return jsonify(task=make_public_task(task))
        return {'task': marshal(task, task_fields)}

    def delete(self, id):
        task = list(filter(lambda x: x['id']==id, tasks))
        if len(task)==0:
            abort(404)
        task = task[0]
        tasks.remove(task)
        return {'result':True}

api.add_resource(TaskListAPI, '/todo/api/v1.0/tasks', endpoint='tasks')
api.add_resource(TaskAPI, '/todo/api/v1.0/tasks/<int:id>', endpoint='task')


def make_public_task(task):
    new_tasks = {}
    for field in task:
        if field=='id':
            new_tasks['uri'] = url_for('task', id=task['id'], _external=True)
        else:
            new_tasks[field] = task[field]
    return new_tasks


@auth.get_password
def get_password(username):
    if username=='hukx':
        return '123456'
    return None

@auth.error_handler
def unauthorized():
    # return make_response(jsonify(error='Unauthorized access'), 401)
    return make_response(jsonify(error='Unauthorized access'), 403)



if __name__ == '__main__':
    app.run(debug=True)


原文链接:http://www.pythondoc.com/flask-restful/second.html

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

推荐阅读更多精彩内容