Flask-RESTful 的介绍和基本使用
Flask-RESTful 是一个 Flask 扩展,它添加了快速构建 REST API 的支持。
环境安装:(终端执行)
pip install flask-restful
文档:
点我查看官方文档
点我查看中文翻译
构建RESTAPI
使用 flask-restful 构建RESTAPI只需要进行三步操作
创建扩展/组件对象
组件对象 = Api(app)
定义类视图
class 自定义视图类(Resource):
组件添加类视图
组件对象.add_resource(视图类, URL资源段)
代码示例:
from flask import Flask
from flask_restful import Api, Resource
app = Flask(__name__)
# 1. 创建API对象 用于管理类视图(资源)
api = Api(app)
# 2.定义类视图 继承Resource
class DemoResource(Resource):
def get(self):
# 类视图响应的content-type默认变为json形式
# 类视图的返回值可以是字典, 会被自动转为json字符串
return {'foo': 'get'}
def post(self):
return {'foo': 'post'}
# 3.添加类视图 函数标记默认为类名小写
api.add_resource(DemoResource, '/', endpoint='demo')
# @('/')
# def index():
#
# return "index"
if __name__ == '__main__':
print(app.url_map)
app.run(debug=True)
类视图的优点
类视图响应的 content-type 默认变为 JSON形式
类视图的 返回值可以是字典, 会被自动转为json字符串