Python Flask集成Swagger后如何定义根路径/端点做服务启动检测

直接使用原生Flask的路由装饰器即可完成根端点注册，flask-restx的Api实例是基于原Flask app扩展实现的，不会覆盖原生路由的注册能力。

具体操作：在main.py中app实例初始化完成后的任意位置添加如下代码：

@app.route('/')
def health_check():
    # 可自定义返回内容用于服务存活检测
    return {"status": "ok", "message": "应用启动成功"}, 200

位置示例 #

参考你现有代码的插入位置如下：

app = create_app(os.getenv('env'))

# 此处插入根路由定义
@app.route('/')
def health_check():
    return {"status": "ok", "message": "应用启动成功"}, 200

api = Api(app, version='1.0', title='Sample API',
          description='A sample API', doc='/api')

补充说明 #

如果需要将根端点也纳入Swagger文档统一管理，可以通过新增对应namespace的方式实现，仅用于健康检测的轻量端点用原生路由注册更简洁，不会和现有/api、/userinfo/路由产生冲突。

内容的提问来源于stack exchange，提问作者Saturnian