コンテンツにスキップ

Editor Support

Warning

This page hasn’t been translated into your language yet. 🌍

We’re currently switching to an automated translation system 🤖, which will help keep all translations complete and up to date.

Learn more: Contributing - Translations

The official FastAPI Extension enhances your FastAPI development workflow with path operation discovery, navigation, as well as FastAPI Cloud deployment, and live log streaming.

For more details about the extension, refer to the README on the GitHub repository.

Setup and Installation

The FastAPI Extension is available for both VS Code and Cursor. It can be installed directly from the Extensions panel in each editor by searching for "FastAPI" and selecting the extension published by FastAPI Labs. The extension also works in browser-based editors such as vscode.dev and github.dev.

Application Discovery

By default, the extension will automatically discover FastAPI applications in your workspace by scanning for files that instantiate FastAPI(). If auto-detection doesn't work for your project structure, you can specify an entrypoint via [tool.fastapi] in pyproject.toml or the fastapi.entryPoint VS Code setting using module notation (e.g. myapp.main:app).

Features

  • Path Operation Explorer - A sidebar tree view of all path operations in your application. Click to jump to any route or router definition.
  • Route Search - Search by path, method, or name with Ctrl + Shift + E (on macOS: Cmd + Shift + E).
  • CodeLens Navigation - Clickable links above test client calls (e.g. client.get('/items')) that jump to the matching path operation for quick navigation between tests and implementation.
  • Deploy to FastAPI Cloud - One-click deployment of your app to FastAPI Cloud.
  • Stream Application Logs - Real-time log streaming from your FastAPI Cloud-deployed application with level filtering and text search.

If you'd like to familiarize yourself with the extension's features, you can checkout the extension walkthrough by opening the Command Palette (Ctrl + Shift + P or on macOS: Cmd + Shift + P) and selecting "Welcome: Open walkthrough..." and then choosing the "Get started with FastAPI" walkthrough.