mirror of
https://github.com/fastapi/fastapi.git
synced 2026-02-26 19:57:59 -05:00
🎨 Auto format
This commit is contained in:
@@ -4,15 +4,15 @@ The official [**FastAPI extension**](https://marketplace.visualstudio.com/items?
|
||||
|
||||
For more details about the extension, refer to the README on the [GitHub repository](https://github.com/fastapi/fastapi-vscode).
|
||||
|
||||
## Setup and Installation
|
||||
## Setup and Installation { #setup-and-installation }
|
||||
|
||||
The FastAPI extension is available for both [VS Code](https://code.visualstudio.com/) and [Cursor](https://www.cursor.com/). 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](https://vscode.dev) and [github.dev](https://github.dev).
|
||||
|
||||
### Application Discovery
|
||||
### Application Discovery { #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
|
||||
## Features { #features }
|
||||
|
||||
- **Path Operation Explorer** — A sidebar tree view of all routes in your application; click to jump to any route or router definition.
|
||||
- **Route Search** — Search routes by path, method, or name with `Ctrl+Shift+E` (`Cmd+Shift+E` on Mac).
|
||||
@@ -20,4 +20,4 @@ By default, the extension will automatically discover FastAPI applications in yo
|
||||
- **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 `Cmd+Shift+P` on Mac) and selecting "Welcome: Open walkthrough..." and then choosing the "Get started with FastAPI" walkthrough.
|
||||
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 `Cmd+Shift+P` on Mac) and selecting "Welcome: Open walkthrough..." and then choosing the "Get started with FastAPI" walkthrough.
|
||||
|
||||
Reference in New Issue
Block a user