1.Flask-RESTful 概述;
1.1 Flask-RESTful 提供的最主要的基础就是资源(resources)。资源(Resources)是构建在 Flask 可拔插视图 之上,只要在你的资源(resource)上定义方法就能够容易地访问多个 HTTP 方法。一个待办事项应用程序的基本的 CRUD 资源看起来像这样:提供的最主要的基础就是资源(resources)。资源(Resources)是构建在 Flask 可拔插视图 之上,只要在你的资源(resource)上定义方法就能够容易地访问多个 HTTP 方法。一个待办事项应用程序的基本的 CRUD 资源看起来像这样:
1.2 思维导图;
2.实例代码;
from flask import Flask, request
from flask_restful import reqparse, abort, Api, Resource
app = Flask(__name__)
api = Api(app)
opsList = {
'ops01': {'task': '我是第一系统运维'},
'ops02': {'task': '我是第二个应用运维'},
'ops03': {'task': '我是第三个运维开发'}
}
def abort_if_todo_doesnt_exist(ops_id):
if ops_id not in opsList:
abort(404, message="OPS {} doesn't exist".format(ops_id))
parser = reqparse.RequestParser()
parser.add_argument('task', type=str)
class Todo(Resource):
def get(self, ops_id):
abort_if_todo_doesnt_exist(ops_id)
return opsList[ops_id]
def delete(self, ops_id):
abort_if_todo_doesnt_exist(ops_id)
del opsList[ops_id]
return '', 204
def put(self, ops_id):
args = parser.parse_args()
task = {'task': args['task']}
opsList[ops_id] = task
return task, 201
class TodoList(Resource):
def get(self):
return opsList
def post(self):
args = parser.parse_args()
todo_id = int(max(opsList.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id
opsList[todo_id] = {'task': args['task']}
return opsList[todo_id], 201
api.add_resource(TodoList, '/opslist')
api.add_resource(Todo, '/opslist/<todo_id>')
if __name__ == '__main__':
app.run(
debug=True)
(1)引入需要的库名、函数、变量等,并做简单的Application初始化:
from flask import Flaskfrom flask_restful import reqparse, abort, Api, Resource
app = Flask(__name__)
api = Api(app)
(2)定义我们需要操作的资源类型(都是json格式的):
TODOS = { 'todo1': {'task': '我是第一个测试'}, 'todo2': {'task': '我是第二个测试'}, 'todo3': {'task': '我是第三个测试'}, }
(3)Flask-RESTful提供了一个用于参数解析的RequestParser类,类似于Python中自带的argparse类,可以很方便的解析请求中的-d参数,并进行类型转换。
parser = reqparse.RequestParser() parser.add_argument('task')
(4)我们观察标准的API接口,这里的接口可以分为两类:带有item_id的,和不带有item_id的。前者是操作单一资源,后者是操作资源列表或新建一个资源。
从操作单一资源开始,继承Resource类,并添加put / get / delete方法:
class Todo(Resource):
def get(self, ops_id):
abort_if_todo_doesnt_exist(ops_id)
return opsList[ops_id]
def delete(self, ops_id):
abort_if_todo_doesnt_exist(ops_id)
del opsList[ops_id]
return '', 204
def put(self, ops_id):
args = parser.parse_args()
task = {'task': args['task']}
opsList[ops_id] = task
return task, 201
(5)继续操作资源列表,继承Resource类,并添加get / post方法:
class TodoList(Resource):
def get(self):
return opsList
def post(self):
args = parser.parse_args()
todo_id = int(max(opsList.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id
opsList[todo_id] = {'task': args['task']}
return opsList[todo_id], 201
(6)资源操作类定义完毕之后,需要设置路由,即告诉Python程序URL的对应关系。
api.add_resource(TodoList, '/opslist') api.add_resource(Todo, '/opslist/<todo_id>')
这样当我们请求url时,就能根据url类型,找到相应的资源类,并调用对应方法。
3.Postman 进行测试
(1).查询有哪些支持的资源类型;
(2)支持类型的第一个功能接口;
(2)支持类型的第二个功能接口;
(2)支持类型的第三个功能接口;
参考链接:http://www.pythondoc.com/Flask-RESTful/quickstart.html 中文官网;