Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 2.4 KB

File metadata and controls

44 lines (25 loc) · 2.4 KB

FastAPI extension for Visual Studio Code

A Visual Studio Code extension for FastAPI application development. Available on the Visual Studio Marketplace.

Overview

This extension enhances the FastAPI development experience in Visual Studio Code by providing:

Endpoint Explorer

The Endpoint Explorer provides a hierarchical tree view of all FastAPI routes in your application. You can expand routers to see their associated endpoints, and click on any route to jump directly to its definition in the code. You can also jump to router definitions by right-clicking on a router node.

Endpoint Explorer GIF

Search for routes

Using ctrl+shift+E (cmd+shift+E on Mac), you can open the Command Palette and quickly search for routes by path, method, or name.

Search Routes GIF

CodeLens for test client calls

CodeLens links appear above HTTP client calls like client.get('/items'), letting you jump directly to the matching route definition.

CodeLens GIF

Settings and customization

Setting Description Default
fastapi.entryPoint Path to the main FastAPI application file (e.g., src/main.py). If not set, the extension searches common locations: main.py, app/main.py, api/main.py, src/main.py, backend/app/main.py. "" (auto-detect)
fastapi.codeLens.enabled Show CodeLens links above test client calls (e.g., client.get('/items')) to navigate to the corresponding route definition. true
fastapi.cloud.enabled Enable FastAPI Cloud integration (status bar, deploy commands). true
fastapi.telemetry.enabled Send anonymous usage data to help improve the extension. See TELEMETRY.md for details on what is collected. true

Note: Currently the extension discovers one FastAPI app per workspace folder. If you have multiple apps, use separate workspace folders or configure fastapi.entryPoint to point to your primary app.

Data and telemetry

The FastAPI extension collects anonymous usage data and sends it to FastAPI to help improve the extension. You can disable telemetry by setting fastapi.telemetry.enabled to false. Read our TELEMETRY.md for details on what we collect and what we don't.

License

MIT