编辑器支持

官方 FastAPI 扩展 通过路径操作（path operation）发现、导航以及 FastAPI Cloud 部署和实时日志流，增强了您的 FastAPI 开发工作流程。

有关该扩展的更多详细信息，请参阅 GitHub 仓库 中的 README 文件。

设置与安装

FastAPI 扩展 适用于 VS Code 和 Cursor。您可以直接从各编辑器的“扩展”面板中搜索“FastAPI”并选择由 FastAPI Labs 发布的扩展进行安装。该扩展也可在基于浏览器的编辑器（如 vscode.dev 和 github.dev）中使用。

应用程序发现

默认情况下，该扩展会自动通过扫描实例化了 FastAPI() 的文件，来发现您工作区中的 FastAPI 应用程序。如果自动检测不适用于您的项目结构，您可以通过 pyproject.toml 中的 [tool.fastapi] 或者使用模块表示法（例如 myapp.main:app）的 fastapi.entryPoint VS Code 设置来指定入口点。

特性

• 路径操作资源管理器 (Path Operation Explorer) - 一个侧边栏树状视图，列出了应用程序中的所有 路径操作。点击即可跳转到任何路由或路由器的定义。
• 路由搜索 (Route Search) - 使用 Ctrl + Shift + E（macOS 上为 Cmd + Shift + E）通过路径、方法或名称进行搜索。
• CodeLens 导航 - 测试客户端调用上方（例如 client.get('/items')）的可点击链接，点击可跳转至对应的路径操作，以便在测试和实现代码之间快速切换。
• 部署到 FastAPI Cloud - 一键将您的应用程序部署到 FastAPI Cloud。
• 流式传输应用程序日志 - 从您部署在 FastAPI Cloud 上的应用程序实时流式传输日志，并支持级别过滤和文本搜索。

如果您想熟悉该扩展的功能，可以通过打开命令面板（Ctrl + Shift + P，或 macOS 上为 Cmd + Shift + P），选择“Welcome: Open walkthrough...”，然后选择“Get started with FastAPI”教程来查看扩展指南。