在 Flask Restful Swagger 的 UI 中隐藏端点

Question

我使用 Flask Restful swagger 来记录 api 文档，但是有一些 api 端点我不想在 swagger 提供的 UI 上显示。有没有办法在代码中做到这一点？

Answer 1

对于任何使用 Flask-restplus 的人来说，您可能正在寻找一种从文档中隐藏端点的方法。

# Hide the full resource
@api.route('/resource1/', doc=False)
class Resource1(Resource):
    def get(self):
        return {}

@api.route('/resource2/')
@api.doc(False)
class Resource2(Resource):
    def get(self):
        return {}

@api.route('/resource3/')
@api.hide
class Resource3(Resource):
    def get(self):
        return {}