diff --git a/docs/en/docs/editor-support.md b/docs/en/docs/editor-support.md new file mode 100644 index 0000000000..51feb542d5 --- /dev/null +++ b/docs/en/docs/editor-support.md @@ -0,0 +1,23 @@ +# Editor Support { #editor-support } + +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 { #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 { #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 } + +- **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. diff --git a/docs/en/docs/tutorial/index.md b/docs/en/docs/tutorial/index.md index 7212a0c4a9..acd1a2d017 100644 --- a/docs/en/docs/tutorial/index.md +++ b/docs/en/docs/tutorial/index.md @@ -84,6 +84,12 @@ If you want to install the standard dependencies but without the `fastapi-cloud- /// +/// tip + +FastAPI has an official extension for VS Code (and Cursor), which provides a lot of features, including a path operation explorer, path operation search, CodeLens navigation in tests (jump to definition from tests), and FastAPI Cloud deployment and logs, all from your editor. + +/// + ## Advanced User Guide { #advanced-user-guide } There is also an **Advanced User Guide** that you can read later after this **Tutorial - User guide**. diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml index 78f03bf443..0db3e7a95b 100644 --- a/docs/en/mkdocs.yml +++ b/docs/en/mkdocs.yml @@ -198,6 +198,7 @@ nav: - advanced/json-base64-bytes.md - advanced/strict-content-type.md - fastapi-cli.md + - editor-support.md - Deployment: - deployment/index.md - deployment/versions.md