时间戳

首页 > 解决方案 > 使用基本 Flask 与 Flask-RESTful 进行 API 开发

python - 使用基本 Flask 与 Flask-RESTful 进行 API 开发

问题描述

我即将为我们即将推出的应用程序开发一个 REST API。我决定使用 Python Flask。但在这一点上，我不知道使用哪个选项。我应该使用基本的 Flask 包还是带有 Flask-RESTful 扩展的 Flask。我发现两者都有一些优点和缺点。

下面是两个 API 做同样事情但在 Flask 和 Flask-RESTful 中的示例：

烧瓶版本：

from flask import Flask, jsonify

app = Flask(__name__)

usersList = ['Aaron', 'Bianca', 'Cat', 'Danny', 'Elena']

@app.route('/users', methods=['GET'])
def users():
    return jsonify({ 'users': [user for user in usersList] })

@app.route('/user/<int:id>', methods=['GET'])
def userById(id):
    return jsonify({ 'username': usersList[id]  })

@app.route('/user/<string:name>', methods=['GET'])
def getUserByName(name):
    # Show some user information
    return "Some info"

@app.route('/user/<string:name>', methods=['POST'])
def addUserByName(name):
    usersList.append(name)
    return jsonify({ 'message': 'New user added'  })

app.run()

Flask-RESTful 版本：

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

usersList = ['Aaron', 'Bianca', 'Cat', 'Danny', 'Elena']

class UsersList(Resource):
    def get(self):
        return { 'users' : [ user for user in usersList  ] }, 200


class UserById(Resource):
    def get(self, id):
        return { 'username': usersList[id] }


class UserByName(Resource):
    def post(self, name):
        usersList.append(name)

        return { 'message': 'New user added'}


api.add_resource(UsersList, '/users')
api.add_resource(UserById, '/user/<int:id>')
api.add_resource(UserByName, '/user/<string:name>')

app.run()

GET /user/<int:id>使用 Flask-RESTful ，我无法获得单个资源来服务多个相关端点GET /user/<string:name>，GET /user/<int:id>/friends如. 由于这个原因，我更倾向于只使用 Flask，因为只定义了函数，并且可以根据我的需要自由定义端点。

牢记以上几点，可以在 Flask-RESTful 中为子资源创建许多类吗？还是我更适合使用 Flask？或者 Flask-RESTful 比 Flask 提供了一些非常好的优势？

标签： pythonapiflask

解决方案

REST 是一个非常灵活的架构，但是在您仅使用 Flask 的方法中，有几点值得考虑，Flask-RESTful 鼓励您远离：

  1. 按照惯例，对单个资源（例如 /users/1234）的 GET 是通过资源的唯一标识符进行的。不能保证用户名是唯一的，因此将其作为 URI 中的标识符（例如 /users/joe）是有风险的。

  2. 当您访问集合中的用户时，最好始终使用复数名词（而不是像您在 Flask 示例中显示的那样，/user/...）。

  3. 当您创建和使用 POST 时，除非您的客户端指定了 id（在这种情况下，它必须能够保证唯一性，所以几乎唯一有效的 id 将是 UUID），您可以只发布到集合 URI （例如 /users/）。

两者都可以，但是使用 Flask-RESTful，您会发现，当您遵循这些准则时，您的类与您的资源更加匹配，并且您不会看到您描述的类的激增。

https://flask-restful.readthedocs.io/en/latest/quickstart.html#full-example演示了一个非常相似的用例。

推荐阅读