에디터 지원
에디터 지원 (Editor Support)
코드를 짤 때 에디터에서 경로 탐색, 정의로 점프, 배포까지 한 번에 되는 경험을 상상해 볼게요. FastAPI 공식 확장 프로그램이 바로 그걸 제공해 줘요. VS Code와 Cursor에서 쓸 수 있고, 에디터 안에서 FastAPI 개발 워크플로우를 굉장히 매끄럽게 만들어 줍니다.
출처: 공식문서
공식 FastAPI Extension은 path operation 탐색·내비게이션, FastAPI Cloud 배포, 라이브 로그 스트리밍으로 FastAPI 개발 워크플로우를 강화해 줘요.
확장 프로그램에 대한 더 자세한 내용은 GitHub 저장소의 README를 참고하세요.
설정과 설치
FastAPI Extension은 VS Code와 Cursor 둘 다에서 쓸 수 있어요. 각 에디터의 Extensions(확장) 패널에서 "FastAPI"를 검색하고 FastAPI Labs가 게시한 확장을 선택하면 바로 설치할 수 있습니다. 확장은 브라우저 기반 에디터인 vscode.dev와 github.dev에서도 동작해요.
어플리케이션 탐지 (Application Discovery)
기본적으로 확장은 워크스페이스에서 FastAPI()를 인스턴스화하는 파일을 스캔해 FastAPI 어플리케이션을 자동으로 찾아요. 프로젝트 구조 때문에 자동 탐지가 안 된다면, pyproject.toml의 [tool.fastapi]나 VS Code 설정의 fastapi.entryPoint로 모듈 표기법(예: myapp.main:app)을 써서 진입점(entrypoint)을 직접 지정할 수 있어요.
기능 (Features)
- Path Operation Explorer - 앱의 모든 path operation(경로·엔드포인트)을 보여주는 사이드바 트리 뷰. 클릭하면 어떤 route든 router 정의든 이동해요.
- Route Search - Ctrl + Shift + E(macOS에서는 Cmd + Shift + E)로 경로·메서드·이름으로 검색.
- CodeLens Navigation - 테스트 클라이언트 호출(예:
client.get('/items')) 위에 표시되는 클릭 가능한 링크로, 일치하는 path operation으로 점프해 테스트와 구현 사이를 빠르게 이동할 수 있어요. - Deploy to FastAPI Cloud - 앱을 FastAPI Cloud에 한 번의 클릭으로 배포.
- Stream Application Logs - FastAPI Cloud에 배포된 앱의 로그를 실시간 스트리밍하고, 레벨 필터와 텍스트 검색 지원.
확장의 기능을 직접 체험해 보고 싶다면, 명령 팔레트(Ctrl + Shift + P, macOS에서는 Cmd + Shift + P)를 열고 "Welcome: Open walkthrough..."를 선택한 뒤 "Get started with FastAPI" 워크스루를 골라 보세요.