Python + Flask 构建RESTful API

最新推荐文章于 2024-08-07 09:09:00 发布

chengsu4428

最新推荐文章于 2024-08-07 09:09:00 发布

阅读量177

点赞数 1

文章标签： python json 后端

原文链接：https://my.oschina.net/ritchielei/blog/673044

版权

1、安装Flask

Flask 是一个 Python 实现的 Web 开发微框架。

在安装好Python的机器上，命令行上输入

$ sudo pip install Flask

即可完成安装

2、简单示例

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello World!'

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

保存文件为 hello.py , 然后在命令行输入 $ python hello.py
 可以看到命令行启动了一个后台服务，然后在浏览器输入 localhost:5000 就可以看到熟悉的 Hello World！了。可以看到Flask的使用非常简单！

3、构建简单RESTful API

1) 导入必要的包，设置简单数据模型

from flask import Flask, jsonify, abort, make_response, request, url_for
#from flask.ext.httpauth import HTTPBasicAuth

app = Flask(__name__)

tasks = [
    {
        'id': 1,
        'title': u'Buy groceries',
        'description': u'Milk, Cheese, Pizza, Fruit, Tylenol',
        'done': False
    },
    {
    'id': 2,
        'title': u'Learn Python',
        'description': u'Need to find a good Python tutorial on the web',
        'done': False
    }
]

token = ''

2）做一个登陆示例，获取用户令牌

@app.route('/todo/api/v1.0/get_token', methods=['POST'])
def get_token():
    if not request.form.get('user'):
       abort(400)

    #user = request.form.get('user')
    #pass = request.form.get('passwd')

    if request.form.get('user') == 'ruby' and request.form.get('passwd') == 'cookie':
        token = 'JLKJADLF09480193'
        return jsonify({'token': token})
    else:
        return jsonify({'error': 'Invalid user or password!! Please re-login!!'})

通过POST方式提交用户名和密码，后端判定是否合法，如果合法就给一个固定TOKEN

@app.route('/todo/api/v1.0/login', methods=['POST'])
def login_verify():
    if not request.json or not 'user' in request.json:
        abort(400)
    if request.json['user'] == 'ruby' and request.json['passwd'] == 'happy':
        token = 'JLKJADLF09480193'
        return jsonify({'token': token})
    else:
        return None

另外一种方式实现登陆，就是在使用JSON包装请求体参数

3）通过传送令牌验证身份，然后做查询，获取所有数据（这里是task）信息

@app.route('/todo/api/v1.0/tasks', methods=['GET'])
def get_tasks():
    req_token = request.args.get('token', u'')
    if req_token != 'JLKJADLF09480193':
        return jsonify({'error': 'invalid token!! Please re-login!!'})
    else:
        return jsonify({'tasks': map(make_public_task, tasks)})

4）获取单个Task

def valid_token(req_token):
    if req_token == 'JLKJADLF09480193':
        return True
    else:
        return False

@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    req_token = request.args.get('token', u'')
    if valid_token(req_token):
        task = filter(lambda t: t['id'] == task_id, tasks)
        if len(task) == 0:
            abort(404)
        return jsonify({'task': task[0]})
    else:
        return jsonify({'error': 'invalid token!! Please re-login!!'})

先先了一个简单的验证TOKEN的函数，然后从数据模型task数组中查询是否存在ID对应的信息，有就返回。

5）创建一个task

@app.route('/todo/api/v1.0/tasks', methods=['POST'])
def create_task():
    if not request.json or not 'title' in request.json or not 'token' in request.json:
        abort(400)
    if not valid_token(request.json['token']):
        return jsonify({'error': 'invalid token!! Please re-login!!'})
    task = {
        'id': tasks[-1]['id'] + 1,
        'title': request.json['title'],
        'description': request.json.get('description', ""),
        'done': False
    }
    tasks.append(task)
    return jsonify({'task': task}), 201

同样的，验证TOKEN，然后往数据模型数组中添加一个task

6) 修改操作

@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = filter(lambda t: t['id'] == task_id, tasks)
    if len(task) == 0:
        abort(404)
    if not request.json:
        abort(400)
    if 'title' in request.json and type(request.json['title']) != unicode:
        abort(400)
    if 'description' in request.json and type(request.json['description']) is not unicode:
        abort(400)
    if 'done' in request.json and type(request.json['done']) is not bool:
        abort(400)
    task[0]['title'] = request.json.get('title', task[0]['title'])
    task[0]['description'] = request.json.get('description', task[0]['description'])
    task[0]['done'] = request.json.get('done', task[0]['done'])
    return jsonify({'task': task[0]})

7）删除操作

@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = filter(lambda t: t['id'] == task_id, tasks)
    if len(task) == 0:
        abort(404)
    tasks.remove(task[0])
    return jsonify({'result': True})


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

删除操作函数

然后运行主函数

8）完整代码

附：还可以对接口调用做应用级别控制，如用户名+密码访问接口(参加一下代码注释部分)

from flask import Flask, jsonify, abort, make_response, request, url_for
#from flask.ext.httpauth import HTTPBasicAuth

app = Flask(__name__)

tasks = [
    {
        'id': 1,
        'title': u'Buy groceries',
        'description': u'Milk, Cheese, Pizza, Fruit, Tylenol',
        'done': False
    },
    {
    'id': 2,
        'title': u'Learn Python',
        'description': u'Need to find a good Python tutorial on the web', 
        'done': False
    }
]

token = ''

#auth = HTTPBasicAuth()

#@auth.get_password
#def get_password(username):
#    if username == 'ok':
#        return 'python'
#    return None

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

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

def valid_token(req_token):
    if req_token == 'JLKJADLF09480193':
        return True
    else:
        return False

@app.route('/todo/api/v1.0/tasks', methods=['GET'])
def get_tasks():
    req_token = request.args.get('token', u'')
    if req_token != 'JLKJADLF09480193':
        return jsonify({'error': 'invalid token!! Please re-login!!'})
    else:
        return jsonify({'tasks': map(make_public_task, tasks)})

@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    req_token = request.args.get('token', u'')
    if valid_token(req_token):
        task = filter(lambda t: t['id'] == task_id, tasks)
        if len(task) == 0:
            abort(404)
        return jsonify({'task': task[0]})
    else:
        return jsonify({'error': 'invalid token!! Please re-login!!'})

@app.errorhandler(404)
def not_found(error):
    return make_response(jsonify({'error': 'Not found'}), 404)

@app.route('/todo/api/v1.0/get_token', methods=['POST'])
def get_token():
    if not request.form.get('user'):
       abort(400)
    
    #user = request.form.get('user')
    #pass = request.form.get('passwd')
    
    if request.form.get('user') == 'ruby' and request.form.get('passwd') == 'cookie':
        token = 'JLKJADLF09480193'
	return jsonify({'token': token})
    else:
        return jsonify({'error': 'Invalid user or password!! Please re-login!!'})

@app.route('/todo/api/v1.0/login', methods=['POST'])
def login_verify():
    if not request.json or not 'user' in request.json:
        abort(400)
    if request.json['user'] == 'ruby' and request.json['passwd'] == 'happy':
        token = 'JLKJADLF09480193'
	return jsonify({'token': token})
    else:
        return None

@app.route('/todo/api/v1.0/tasks', methods=['POST'])
def create_task():
    if not request.json or not 'title' in request.json or not 'token' in request.json:
        abort(400)
    if not valid_token(request.json['token']):
        return jsonify({'error': 'invalid token!! Please re-login!!'})
    task = {
        'id': tasks[-1]['id'] + 1,
        'title': request.json['title'],
        'description': request.json.get('description', ""),
        'done': False
    }
    tasks.append(task)
    return jsonify({'task': task}), 201

@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = filter(lambda t: t['id'] == task_id, tasks)
    if len(task) == 0:
        abort(404)
    if not request.json:
        abort(400)
    if 'title' in request.json and type(request.json['title']) != unicode:
        abort(400)
    if 'description' in request.json and type(request.json['description']) is not unicode:
        abort(400)
    if 'done' in request.json and type(request.json['done']) is not bool:
        abort(400)
    task[0]['title'] = request.json.get('title', task[0]['title'])
    task[0]['description'] = request.json.get('description', task[0]['description'])
    task[0]['done'] = request.json.get('done', task[0]['done'])
    return jsonify({'task': task[0]})

@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = filter(lambda t: t['id'] == task_id, tasks)
    if len(task) == 0:
        abort(404)
    tasks.remove(task[0])
    return jsonify({'result': True})


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

3、运行程序

将文件保存，如 api.py 然后在命令行运行 $ python api.py

即可启动接口服务

转载于:https://my.oschina.net/ritchielei/blog/673044