restful API规范
- url链接，不能有动词，只能有名词，出现复数，就加s
image.png
常用状态码
- 200 服务器成功响应客户端的请求
- 201 创建新资源成功
- 204 资源被删除成功（可以不真的重数据库删除，可以增加一个状态status=207等来表示属于删除的资源）
- 400 bad request
- 401用户没权限
- 403 因为某些原因禁止访问这个请求
- 404 用户发送的url不存在
- 406 用户请求不被服务器接收，（比如服务器期望客户端发送某个字段，但是没有发送）
- 500 服务器内部错误，
使用 Python 和 Flask 实现 RESTful services（一）
from flask import Flask, jsonify, abort, make_response, request, redirect, url_for
from flask_restful import Resource, Api
app = Flask(__name__)
api = Api(app)
tasks = [{
'id': 1,
'title': "python书籍",
'content': "我是python入门书籍，了解一下"
},
{
'id': 2,
'title': "Java书籍",
'content': "我是java入门书籍，了解一下"
}
]
#查询所有tasks
@app.route("/todo/api/v1.0/tasks", methods=["GET"])
def get_tasks():
return jsonify(tasks)
@app.errorhandler(404)
def not_found(error):
return jsonify({'error': 'not found'}),404
if __name__ == '__main__':
app.run()
效果图：
image.png
#根据id查询 ，python3中，filter是一个可遍历的对象，用list直接转成列表
@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
task = list(filter(lambda t: t['id'] == task_id, tasks))
if len(task) == 0:
abort(404)
else:
data = task[0]
if data:
print(data)
return jsonify(data)
image.png
增加一个task,201表示创建新资源成功
#添加一个tasks
@app.route('/todo/api/v1.0/tasks/add', methods=['POST'])
def create_taask():
if not request.form or not 'title' in request.form:
abort(404)
task = {"id": request.form['id'], 'title': request.form['title']
, 'content': request.form.get('content', "")}
tasks.append(task)
return jsonify(tasks), 201
image.png
@app.route("/todo/api/v1.0/tasks/del", methods=["POST"])
def del_task():
if not request.form or not "id" in request.form:
abort(404)
else:
id = request.form.get("id")
print(type(id))
# 注意获取的是str类型
task = list(filter(lambda t: t['id'] == int(id), tasks))
if len(task) == 0:
abort(404)
else:
data = task[0]
if data:
tasks.remove(data)
return jsonify(tasks)
image.png
以上代码就使用flask提供的jsonify实现一个查看列表，查看某一条信息，增加某一条，删除某一条的基本接口使用，注意到没得，增加的id=a，没有做验证，id重复也没有验证。平常，最好是结合数据库来操作。更多使用flask-restful插件
加强 RESTful web service 的安全性
不加以验证，如果一个陌生人弄清我们的 API 是如何工作的，他或她可以编写一个客户端访问我们的 web service 并且毁坏我们的数据。
注意：确保我们的 web service 安全服务的最简单的方法是要求客户端提供一个用户名和密码。在常规的 web 应用程序会提供一个登录的表单用来认证，并且服务器会创建一个会话为登录的用户以后的操作使用，会话的 id 以 cookie 形式存储在客户端浏览器中。然而 REST 的规则之一就是 “无状态”， 因此我们必须要求客户端在每一次请求中提供认证的信息。
既然我们需要实现认证我们需要在 HTTP 上下文中去完成，HTTP 协议提供了两种认证机制: Basic 和 Digest。
flask-httpauth插件
from flask_httpauth import HTTPBasicAuth
auth = HTTPBasicAuth()
"""@auth.get_password
def get_password(username):
if username == 'admin':
return '123456'
return None"""
"""@auth.verify_password
def verify_password(email,password):
pass
if user.verify_password(password):
return True"""
@auth.error_handler
def unauthorized():
return make_response(jsonify({'error': 'Unauthorized access'}), 401)
...
@app.route("/todo/api/v1.0/tasks", methods=["GET"])
@auth.login_required
def get_tasks():
return jsonify(tasks)
复制地址到浏览器，会弹出输入框，为了不要输入框可改成error_handler中可改成403
注意，验证的话，我们可以用get_password,来验证user叫admin,密码是123456的用户，或者验证用户中有没得叫某某名字的，只要唯一，我们就可以用来验证，或者使用verfy_password来参考资料
参考资料2
最后感谢文章作者：传送门
