3.9 KiB
Поддержка редактора кода
Официальное расширение FastAPI улучшает ваш процесс разработки на FastAPI за счет обнаружения и навигации по операциям пути (обработчикам пути), а также развертывания в FastAPI Cloud и потоковой передачи логов в реальном времени.
Подробности о расширении смотрите в README в репозитории GitHub.
Установка и настройка
Расширение FastAPI доступно как для VS Code, так и для Cursor. Его можно установить напрямую из панели расширений в каждом редакторе кода, выполнив поиск по «FastAPI» и выбрав расширение от FastAPI Labs. Расширение также работает в браузерных редакторах кода, таких как vscode.dev и github.dev.
Обнаружение приложения
По умолчанию расширение автоматически обнаруживает приложения FastAPI в вашем рабочем пространстве, сканируя файлы, где создается экземпляр FastAPI(). Если авто-обнаружение не подходит для структуры вашего проекта, вы можете указать точку входа через [tool.fastapi] в pyproject.toml или настройку VS Code fastapi.entryPoint, используя модульную нотацию (например, myapp.main:app).
Возможности
- Обозреватель операций пути — древовидное представление на боковой панели всех операций пути вашего приложения. Нажмите, чтобы перейти к любому маршруту или определению роутера.
- Поиск маршрутов — поиск по пути, методу или имени с помощью 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».