파이썬으로 FastAPI 서버 만들기

 

---

Visual Studio Code(VS Code)에서 FastAPI 모듈을 설치하려면 Python 가상환경을 설정하고 pip 명령어를 사용하여 FastAPI와 기타 필요한 패키지를 설치하면 됩니다. 아래 단계에 따라 FastAPI 환경을 설정해 보세요.

---

1. FastAPI와 Uvicorn 설치

FastAPI를 실행하려면 FastAPI와 ASGI 서버인 Uvicorn을 설치해야 합니다.

 

• 터미널에서 다음 명령어를 실행하여 FastAPI와 Uvicorn을 설치합니다.
   

pip install fastapi uvicorn

 

2. VS Code 설정 (선택 사항)

• Python 확장팩 설치: VS Code의 확장 시장에서 Python 확장팩을 설치하여 Python 코드 편집과 디버깅을 쉽게 할 수 있습니다.
• Python 인터프리터 선택:
  1. Command Palette (Ctrl+Shift+P 또는 Cmd+Shift+P on macOS) 열기.
  2. "Python: Select Interpreter" 입력하고 선택.
  3. 생성한 가상환경의 인터프리터(예: ./venv/bin/python 또는 .\venv\Scripts\python.exe)를 선택.

 

3. FastAPI 애플리케이션 실행

 

main.py 파일이 FastAPI 애플리케이션을 포함하고 있다고 가정하고, Uvicorn을 사용하여 서버를 실행할 수 있습니다.

• 터미널에서 다음 명령어를 실행하여 FastAPI 애플리케이션을 실행합니다.
  • --reload: 코드 변경 시 자동으로 서버를 다시 시작하는 옵션입니다. 개발 중에 유용합니다.
  • main:app: main.py 파일에서 FastAPI 인스턴스(app)를 지정하는 방식입니다.

uvicorn main:app --reload

 

4. FastAPI 설치 확인

• FastAPI 설치 확인: 설치가 완료되었는지 확인하려면 다음 명령어로 설치된 패키지 목록에서 FastAPI와 Uvicorn이 있는지 확인합니다.

pip list

 

 

5. 브라우저에서 호출

• FastAPI 애플리케이션이 실행 중이라면, 브라우저에서 애플리케이션의 루트 URL로 접속할 수 있습니다.

http://localhost:8000/

 

6. 문서페이지 호출

• FastAPI는 자동으로 OpenAPI 문서와 Swagger UI를 생성합니다. 서버가 실행 중일 때, 다음 URL로 접속하여 API 문서를 확인할 수 있습니다.

http://localhost:8000/docs
http://localhost:8000/redoc

 

 

---

안되는데요?

Q.

uvicorn main:app --reload 실행시 오류가 나요.

 

A.

현재 터미널 경로(D:\miniconda3\envs)에서 main.py 파일이 있는지 확인하세요.

uvicorn 명령어를 실행하는 위치가 main.py 파일이 있는 폴더와 일치해야 합니다.

main.py가 다른폴더에 있다면 해당 폴더로 이동한 후 명령어를 실행해야 합니다.