Flask-RestactionRESTful API 框架

Flask-Restaction，为RESTful API而生的Web框架：

• 创建RESTful API

• 校验用户输入以及将输出转化成合适的响应格式

• 身份验证和权限控制

• 自动生成Javascript SDK和API文档

注意：仅支持Python3.3+

安装

pip install flask-restaction

对比其它框架

flask-restful

flask-restaction 相对于 flask-restful 有什么优势，或是什么特性?

• 输入输出校验

  restaction 是声明式的，简单明确:

  class Hello:
  
      def get(self, name):
          """
          Get welcome message
  
          $input:
              name?str&escape&default="world": Your name
          $output:
              message?str: Welcome message
          """

   

  restaction 的输出校验和输入校验一样简单，而且可以序列化任意类型的对象。

  restful 中叫做 Request Parsing:

  from flask_restful import reqparse
  
  parser = reqparse.RequestParser()
  parser.add_argument('name', type=str, help='Your name')
  args = parser.parse_args()

   

  Request Parsing 很繁琐，不能很好的重用代码。

• 清晰的URL规则

  restaction 的 URL 规则清晰，并始终保持一致，减少了编码和阅读API文档的负担。

• 身份验证及权限控制

  restaction 提供一个灵活的权限系统，身份验证基于 json web token， 权限验证是通过json配置文件，而不是散布在代码中的装饰器。

• 自动生成文档和res.js

  restaction 可以自动生成文档和 res.js，用 res.js 可以方便的调用 api。