什么是RESTFul?
1.简介
REST即表述性状态传递,是Roy Fielding提出的一种软件架构风格。它是一种针对网络应用的设计和开发方式,可以降低开发的复杂性,提高系统的可伸缩性。
是一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。
REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。遵循restful开发的应用程序接口(API)称为RESTFul API。RESTFul的接口都是围绕资源以及对资源的各种动作展开的。
2.资源
所谓的资源就是在网络中存在的任意实体,哪怕是一条简单信息。通俗讲就是我们访问的每个页面
数据之间传输格式:使用json
,而不使用xml
。
3.动作
所谓动作就是数据的CURD。在开发者设计良好的前提下,对网络资源的动作都可抽象为对资源的CURD操作。RESTFul对网络的操作抽象为HTTP的GET、POST、PUT、DELETE等请求的方式以完成对资源的增删改查。具体对照如下:
方法 | 行为 | 示例 |
GET | 获取资源信息 | http://127.0.0.1:5000/source |
GET | 获取指定资源 | http://127.0.0.1:5000/source/250 |
POST | 创建新的资源 | http://127.0.0.1:5000/source |
PUT | 更新指定资源 | http://127.0.0.1:5000/source/250 |
DELETE | 删除指定资源 | http://127.0.0.1:5000/source/250 |
4.数据
通常传输的数据格式都采用JSON,有时也可以通过URL的参数进行传递
5.工具
说明:postman是一款非常好用的API开发测试工具,可以模拟各种请求
提醒:安装包,一路next完成安装,演示一个地址的访问
使用Flask-restful
Flask-RESTful是一个Flask的扩展,它增加了对快速构建REST APIs的支持。它是一种轻量级的抽象,可以与现有的ORM/库一起工作。Flask-RESTful励以最少的安装方式进行最佳实践
安装:pip install flask-restful
flask-restuflu中每种资源抽象成类,需要继承自Resource
下面是一个最小的API例子:
from flask import Flask
from flask_restful import Resource, Api
app = Flask(__name__) #用flask创建app
api = Api(app) #用Api来绑定app
class HelloWorld(Resource):
def get(self):
return {'hello': 'world'}
api.add_resource(HelloWorld, '/') #通过把URLs传给Api对象的add_resource()方法,访问到你的资源
if __name__ == '__main__':
app.run(debug=True)
端点扩展:
1.资源通过多个URLs访问: api.add_resource(HelloWorld,'/','/hello')
2.将路径的部分匹配为资源方法的变量:
api.add_resource(Todo,'/todo/<int:todo_id>',endpoint='todo_ep')
解析:
(1)endpoint是用来给url_for反转url的时候指定的。
如果不写endpoint,那么将会使用视图的名字的小写来作为endpoint。
(2):add_resource的第二个参数是访问这个视图函数的url,这个url可以跟之前的route一样,可以传递参数
。并且还有一点不同的是,这个方法可以传递多个url来指定这个视图函数。
3.如果一个请求与你的应用程序端点中的任何一个都不匹配,Flask-RESTful 将会返回404错误.
并附带一段有关其它最相似匹配的端点建议。你可以通过在配置中将ERROR_404_HELP设置为 False禁用此项。
参数解析
访问写完,那程序如何解析呢?
Flask-RESTful 内置了支持验证请求数据,它使用了一个类似argparse 的库。
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的错误请求以及高亮的错误信息回应,如下:
$ curl -d 'rate=foo' http://127.0.0.1:5000/todos
==》 {'status': 400, 'message': 'foo cannot be converted to int'}
inputs模块提供许多常用的转换函数,像 inputs.date() 和 inputs.url()。
调用 parse_args 传入 strict=True 能够确保当请求包含了你的解析器中未定义的参数时抛出一个异常。
args = parser.parse_args(strict=True)
完整例子
# -*- coding: utf-8 -*-
from flask import Flask
from flask_restful import reqparse, abort, Api, Resource
#做简单的Application初始化
app = Flask(__name__)
api = Api(app) #用Api来绑定app
#定义我们需要操作的资源类型(都是json格式的)
TODOS = {
'todo1': {'task': 'build an API'},
'todo2': {'task': '哈哈哈'},
'todo3': {'task': 'profit!'},
}
#验证todo_id是否在TODOS当中
def abort_if_todo_doesnt_exist(todo_id):
if todo_id not in TODOS:
abort(404, message="Todo {} doesn't exist".format(todo_id))
#参数解析的RequestParser类,可以很方便的解析请求中的-d参数,并进行类型转换
parser = reqparse.RequestParser()
parser.add_argument('task')
#操作(put / get / delete)单一资源Todo
class Todo(Resource):
def get(self, todo_id):
abort_if_todo_doesnt_exist(todo_id) #进行请求前,先做id确认
return TODOS[todo_id] #从TODOS字典中读取数据
def delete(self, todo_id):
abort_if_todo_doesnt_exist(todo_id)
del TODOS[todo_id]
return '', 204
def put(self, todo_id):
args = parser.parse_args()
task = {'task': args['task']}
TODOS[todo_id] = task
return task, 201
# # 操作(post / get)资源列表TodoList
class TodoList(Resource):
def get(self):
return TODOS
def post(self):
args = parser.parse_args()
todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id
TODOS[todo_id] = {'task': args['task']}
return TODOS[todo_id], 201
# 设置路由,即告诉Python程序URL的对应关系
api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/<todo_id>')
if __name__ == '__main__':
app.run(debug=True)
以下用postman工具验证结果
查询列表:
查询单任务:
删除任务:
添加任务(这是用post表单形式,还可以改成json形式啦):
更新任务:
ok,后台flask已经返回数据了,那前端怎么接收呢,后面再举一例解释
前后端分离简单理解
flask中返回json格式数据
简单前后端分离:
前端页面变成一个静态文件。存放在项目的static/html目录下:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Score List</title>
<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script>
<script>
$(function (){
$.getJSON("/getscores/", function (data){ #引入data
console.log(data);
var scores = data["scores"]; #data中获取对应数据
var $ul = $("#score_container");
for(var i=0; i < scores.length; i++){
var $li = $("<li></li>").html(scores[i]);
$ul.append($li);
}
})
})
</script>
</head>
<body>
<h2>机试成绩表</h2>
<ul id="score_container"></ul>
</body>
</html>
后端只需要返回json数据即可:
@app.route('/getscores/')
def get_scores():
data = {
'msg': 'ok',
'status': '200',
'scores': [1,2,3,4,5,6,30,40]
}
return jsonify(data)
ok,记录到此~