用光学仪器记录烧瓶API
optic-document-flask的Python项目详细描述
烧瓶用光学元件
光学代理设置
构建在flask之上的pythonapi很容易使用我们的定制中间件连接到optic。在本教程中,我们将向您展示如何将optic文档中间件连接到flask应用程序,以便您的集成测试在执行时记录您的代码。
将中间件添加到项目中
使用pip安装Optic文档中间件
pip3 install optic-document-flask
使中间件在测试期间运行
现在将中间件添加到Flask应用程序中因为我们只希望中间件在optic执行测试时运行,所以请确保在检查OPTIC_SERVER_LISTENING
环境变量时对其进行包装。
我们喜欢在设置测试配置的块中执行此检查,但您可以在任何对应用程序有意义的地方执行此检查。
fromopticimportOpticDocumentingMiddlewaredefcreate_app(test_config=None):# Setup Code...iftest_configisNone:# load the instance config, if it exists, when not testingapp.config.from_pyfile('config.py',silent=True)else:if'OPTIC_SERVER_LISTENING'inos.environ:OpticDocumentingMiddleware(app)app.config.update(test_config)returnapp
使用代理设备
文档中间件将记录测试运行的所有请求/响应因为它是在中间件级别集成的,所以不需要更新任何测试文件或设备