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

Question

我将为即将到来的应用程序开发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()

用瓶的RESTful，我不能让一个单一的资源服务于多个相关端点像GET /user/<int:id>，GET /user/<string:name>，GET /user/<int:id>/friends等等。而且因为我可能会与许多班结束了，我不知道是否创建简单的子资源新类是一个很好的做法。由于这个原因，我更倾向于只使用Flask，因为仅定义了函数，并且可以根据需要自由定义端点。

牢记以上几点，可以在Flask-RESTful中为子资源创建许多类吗？还是我最好使用Flask？还是Flask-RESTful提供了一些比Flask真正好的优势？

Answer 1

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

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

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

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

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

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

Answer 2

我建议您使用Flask-RESTplus，这将为您提供全面的 Swagger 支持。

就仅使用 Flask 而言，我想说获得 Swagger 功能也是选择 Flask-Restplus 的一个重要因素。