有关RESTful API的介绍，请参考这篇文章Flask REST
REST的六个特性：
- Client-Server：服务器端与客户端分离。
- Stateless（无状态）：每次客户端请求必需包含完整的信息，换句话说，每一次请求都是独立的。
- Cacheable（可缓存）：服务器端必需指定哪些请求是可以缓存的。
- Layered System（分层结构）：服务器端与客户端通讯必需标准化，服务器的变更并不会影响客户端。
- Uniform Interface（统一接口）：客户端与服务器端的通讯方法必需是统一的。
- Code on demand（按需执行代码？）：服务器端可以在上下文中执行代码或者脚本？
GET：检索人物
POST：添加任务
PUT：更新存在人物
DELETE：删除一个任务
** 不用扩展模块实现REST **
在views.py文件中添加两个task列表，列表内容放在内存中，json数据格式
GET检索任务
from flask import Flask, jsonify
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
}
]
@flask_app.route('/api/v1.0/tasks', methods=['GET'])
def get_tasks():
return jsonify({'tasks': tasks})
这就调用了一个RESTful service方法。
如果觉得网页测试太麻烦，可以使用curl命令，也可以使用firefox插件RESTeasy进行测试
$ curl http://192.168.1.109:316/api/v1.0/tasks
{
"tasks": [
{
"description": "Milk, Cheese, Pizza, Fruit, Tylenol",
"done": false,
"id": 1,
"title": "Buy groceries"
},
{
"description": "Need to find a good Python tutorial on the web",
"done": false,
"id": 2,
"title": "Learn Python"
}
]
}
带有参数的REST方法
from flask import abort
@flask_app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
task = filter(lambda t: t['id'] == task_id, tasks)
if len(task) == 0:
abort(404)
return jsonify({'task': task[0]})
运行结果
$ curl http://192.168.1.109:316/api/v1.0/tasks/2
{
"task": {
"description": "Need to find a good Python tutorial on the web",
"done": false,
"id": 2,
"title": "Learn Python"
}
}
对404错误进行处理
from flask import make_response
@flask_app.errorhandler(404)
def not_found(error):
return make_response(jsonify({'error': 'Not found'}), 404)
POST：添加任务
### POST ###
@flask_app.route('/api/v1.0/tasks', methods=['POST'])
def create_task():
if not request.json or not 'title' in request.json:
abort(400)
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
@flask_app.errorhandler(400)
def bad_request(error):
return make_response(jsonify({'error': 'User defined Bad request'}), 400)
curl -i -H "Content-Type: application/json" -X POST \
-d '{"title":"Read a book"}' http://192.168.1.109:316/api/v1.0/tasks
如果使用原生版本的curl命令行提示符，上面的命令会正确执行。如果是在Windows下使用Cygwin bash版本的curl，需要将body部份添加双引号：
curl -i -H "Content-Type: application/json" -X POST -d "{"""title""":"""Read a book"""}" http://192.168.1.109:316/api/v1.0/tasks
PUT：更新任务
@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]})
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"done":true}' http://192.168.1.109:316/api/v1.0/tasks/2
HTTP/1.1 200 OK
Server: nginx/1.4.6 (Ubuntu)
Date: Wed, 15 Jun 2016 13:01:52 GMT
Content-Type: application/json
Content-Length: 151
Connection: keep-alive
{
"task": {
"description": "Need to find a good Python tutorial on the web",
"done": true,
"id": 2,
"title": "Learn Python"
}
}
DELETE：删除任务
@flask_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})
返回URI
通过Flask的url_for模块，获取任务时，返回uri值，避免了与其它功能的兼容，拿到的是完整uri。
from flask import url_for
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
RESTful web service的安全认证
最简单的办法是在web service中，只允许用户名和密码验证通过的客户端连接。在一个常规的web应用中，应该有登录表单提交去认证，同时服务器会创建一个会话过程去进行通讯。这个会话过程id会被存储在客户端的cookie里面。不过这样就违返了我们REST中无状态的规则，因此，我们需求客户端每次都将他们的认证信息发送到服务器。
有两种方法表单认证方法去做，分别是 Basic 和 Digest。
pip install flask-httpauth
from flask.ext.httpauth import HTTPBasicAuth
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)
$ curl http://192.168.1.109:316/api/v1.0/tasks
{
"error": "Unauthorized access"
}
$ curl -u ok:python -i http://192.168.1.109:316/api/v1.0/tasks
HTTP/1.1 200 OK
修改返回的错误代码401。例如修改成403（”Forbidden“），网页登录就不会弹出验证对话框了。
** 使用扩展模块flask.ext.restful实现REST **
为什么使用扩展模块实现REST
Flask-RESTful 是一个可以简化 APIs 的构建的 Flask 扩展，添加了快速构建 REST APIs 的支持
from flask.ext import restful
api = restful.Api(flask_app)
class Task(restful.Resource):
def get(self):
return {'Wendy':'Simon'}
api.add_resource(Task, '/api/v1.0/ext/tasks', endpoint = 'user')
