Flask 插件学习系列：Restful

    一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。
本文参考：https://baijiahao.baidu.com/s?id=1572275589970400&wfr=spider&for=pc

• 1.安装和导包

$ pip install Flask-RESTful

安装完成后就可以在代码中带入拓展包 from flask_restful import

• 2.不带参数的请求
      resource方法来添加路由，方法的第一个参数是定义的类名，该类需要继承"Resource"基类，其成员函数定义了不同的 HTTP 请求方法的逻辑，如：GET、POST等；第二个参数定义了 URL 路径。

from flask import Flask, request

from flask_restful import Api ,Resource

app = Flask(__name__)

api = Api(app)

USER_LIST = {

'1': {'name':'Michael'},

'2': {'name':'Tom'},

}

class UserList(Resource):

      def get(self):

          return USER_LIST

      def post(self):

          user_id = int(max(USER_LIST.keys)) 

          user_id = '%i' % user_id

          USER_LIST[user_id] = {'name': request.form['name']}

          return USER_LIST[user_id]

api.add_resource(UserList, '/users')

if __name__ == '__main__':
     app.run(host='0.0.0.0', debug=True)

• 3.带参数的请求
  可以直接在定义类的成员函数下直接添加传递的参数
  示例如下：

class User(Resource):

      def get(self, user_id):
             pass
      def delete(self, user_id):
             pass
      def put(self, user_id):
            pass
api.add_resource(User, '/users/')

• 4.参数解析
  在 POST 或 PUT 请求中，直接访问 form 表单并验证的工作有些麻烦。Flask-RESTful 提供了"reqparse"库来简化。

from flask_restful import reqparse

parser = reqparse.RequestParser()

parser.add_argument('name', type=str)

args = parser.parse_args()

USER_LIST[user_id] = {'name': args['name']}

上述代码中通过"parser.add.argument"方法来定义 form 表单字段，并指定其类型（本例中是字符型 str）。

然后在 PUT 函数中，就可以调用"parser.parse.args"来获取表单内容，并返回一个字典，该字典就包含了表单的内容。

parser.parse.args"方法会自动验证数据类型，并在类型不匹配时，返回 400 错误。

你还可以添加"strict"参数，如"parser.parse.args(strict=True)"，此时如果请求中出现未定义的参数，也会返回 400 错误。

• 5.示例

from flask import Flask

from flask_restful import Api, Resource, reqparse, abort

USER_LIST = {

'1': {'name':'Michael'},

'2': {'name':'Tom'},

}

def abort_if_not_exist(user_id):

      if user_id not in USER_LIST:

            abort(404, message="User {} doesn't exist".format(user_id))

            abort_if_not_exist(user_id)

            return '', 204

      args = parser.parse_args(strict=True)

      return USER_LIST[user_id], 201

api.add_resource(User, '/users/')