fastapi/docs/ko/docs/editor-support.md

에디터 지원

공식 FastAPI 확장은 FastAPI 개발 워크플로우를 강화해 줍니다. 경로 처리 탐색 및 이동, FastAPI Cloud 배포, 실시간 로그 스트리밍을 제공합니다.

확장에 대한 자세한 내용은 GitHub 저장소의 README를 참고하세요.

설치 및 설정

FastAPI 확장은 VS Code와 Cursor에서 사용할 수 있습니다. 각 에디터의 확장(Extensions) 패널에서 "FastAPI"로 검색한 뒤 FastAPI Labs가 배포한 확장을 선택해 바로 설치할 수 있습니다. 또한 vscode.dev, github.dev 같은 브라우저 기반 에디터에서도 동작합니다.

애플리케이션 자동 감지

기본적으로 이 확장은 작업 공간에서 FastAPI()를 생성하는 파일을 스캔하여 FastAPI 애플리케이션을 자동으로 감지합니다. 프로젝트 구조상 자동 감지가 어려운 경우, pyproject.toml의 [tool.fastapi] 항목이나 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" walkthrough를 선택해 보세요.