在Flask restful Swagger的UI中隐藏端点

时间:2014-10-01 13:50:07

标签: python swagger flask-restful

我正在使用烧瓶restful swagger for api文档,但是有一些api端点,我不想在swagger提供的UI上显示。有没有办法在代码中这样做?

3 个答案:

答案 0 :(得分:1)

对于任何使用flask-restplus的人,您可能正在寻找hide endpoints from the documentation的方法。

答案 1 :(得分:0)

由于您没有提供太多信息,因此根据文档很难知道您的意思:

# Operations not decorated with @swagger.operation do not get added to the swagger docs

class Todo(Resource):
    def options(self, todo_id):
        """
        I'm not visible in the swagger docs
        """
        pass

即如果您没有装饰您的资源,它们也不会显示在文档中。更多信息,请https://github.com/rantav/flask-restful-swagger

答案 2 :(得分:0)

尝试一下

api = Api(app, doc=False)