python - 在 Flask restful Swagger 的 UI 中隐藏端点

Question

我在 api 文档中使用 flask restful swagger，但是我不想在 swagger 提供的 UI 上显示一些 api 端点。有没有办法在代码中这样做？

Answer 1

对于任何使用 flask-restplus 的人，您可能正在寻找一种方法来 hide endpoints from the documentation .

# 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 {}