将 auth 装饰器添加到 flask restx

Question

我有一个使用flask-restx和flask-login的 Flask 应用程序。 我希望默认情况下所有路由都需要登录，并明确定义不需要身份验证的公共路由。 我已经按照这个问题中给出的示例开始使用装饰器：

使 Flask-Login 的 login_required 成为默认值的最佳方法

它适用于 function 端点，但不适用于restx资源端点。

我尝试添加 function 作为装饰器，并使用method_decorators字段。 例如：

def public_route(decorated_function):
    """
    This is a decorator to specify public endpoints in our flask routes
    :param decorated_function:
    :return:
    """
    decorated_function.is_public = True
    return decorated_function


class HelloWorld(ConfigurableResource):

    method_decorators = {"get": [public_route]}

    @public_route
    @api.doc('Welcome message')
    def get(self):
        return {'hello': 'world'}

这个测试通过了：

def test_hello_world_is_public():
    api = Namespace('health', description='Health related operations')
    hello = HelloWorld(api, config=None, logger=None)
    is_public_endpoint = getattr(hello.get, 'is_public', False)
    assert is_public_endpoint

我的挑战是我看不到如何在我的身份验证逻辑中访问此属性：

    @app.before_request
    def check_route_access():
        """
        This function decides whethere access should be granted to an endpoint.
        This function runs before all requests.
        :return:
        """
        is_public_endpoint = getattr(app.view_functions[request.endpoint], 'is_public', False)

        if person_authorized_for_path(current_user, request.path, is_public_endpoint):
            return
        # Otherwise access not granted
        return redirect(url_for("auth.index"))

这适用于普通的 function 端点，但不适用于 restx 资源。

我知道restx将我的资源 class 包装在 function 中，以便 flask 可以进行调度，但我不知道如何从这里访问装饰器。 所以我有一些问题：

• 是否可以从 view_function 访问装饰器？
• 是否可以知道端点是restx资源还是普通的rest function？
• 有没有更好的方法来做我想要实现的目标？

Answer 1

基于this和this ， method_decorators变量应该是一个函数列表，所以你应该像这样使用它：

def _perform_auth(method):
    is_public_endpoint = getattr(method, 'is_public', False)
    # place the validation here

class Resource(flask_restx.Resource):
    method_decorators = [_perform_auth]

Answer 2

是否可以从 view_function 访问装饰器？

嗯......这是可能的，但我不会推荐它。 这是一个例子

是否可以知道端点是restx资源还是普通的rest function？

您可能可以检查 func 并确定它是否来自 restx，也许可以查看__qualname__ ，但话又说回来，我不会推荐它。

有没有更好的方法来做我想要实现的目标？

我会 go 这些解决方案之一：

• 显式装饰需要身份验证的 view_funcs 和资源，而不是相反
• 为公共端点创建蓝图，使用before_request装饰器为受保护端点创建蓝图以进行授权