[FastAPI] PyCharm Community - setting

PyCharm Pro 버전에서는  FastAPI 관련 라이브러리 설치와 환경 설정이 자동 실행되어 프로젝트 생성이 수월하지만, 

Community 버전은 이 기능이 지원되지 않아 사용자가 직접 해야 한다.

 

 

1. 프로젝트 생성

 

새 가상환경에서 프로젝트를 생성한다.  (로컬에는 python 3.9이 설치되어 있어 3.9 버전을 기준으로 프로젝트를 생성했다)

 

새 가상환경에서 프로젝트 생성

 

2. 라이브러리 설치

 

python packages 탭에서 fastapi와 uvicorn을 설치한다.

 

fastapi 설치

uvicorn 설치

 

터미널이 익숙한 사람은 다음 명령어로 라이브러리를 설치하면 된다. 

pip install fastapi
pip install uvicorn

 

 

3. main.py 파일 생성

 

디렉토리 내에 main.py 파일을 생성한다.

 

main.py 파일 생성

 

main.py 에는 다음과 같이 작성한다. (공식 홈페이지 내용 참고)

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def root():
    return {"message": "Hello World"}

 

참고: https://fastapi.tiangolo.com/ko/tutorial/first-steps/

첫걸음 - FastAPI

 

 

4. 환경 설정

 

main.py 를 바로 실행하면 uvicorn 서버가 구동되지 않으므로 Edit Configurations 에서 따로 모듈을 지정해야 한다.  

 

오른쪽상단의 Current File 을 클릭해서 Edit Configurations 을 선택한다.

+ 버튼을 클릭하고 Python을 추가한다.

Script path 를 Module name으로 변경하고 uvicorn 모듈을 선택한다.

 

Module name에 uvicorn, Parameters에 main: app --reload 을 각각 기입하고 저장한다.

main.py 를 실행하면 FastAPI 서버가 정상적으로 구동되는 것을 확인할 수 있다.

 

기본 port 는 8000 인데, 9000 으로 변경하고 싶다면

Parameters 부분을 main: app --reload --port=9000 으로 기입하면 된다.

 

 

uvicorn main:app 명령은 다음을 의미: main: 파일 main.py (파이썬 "모듈"). app: main.py 내부의 app = FastAPI() 줄에서 생성한 오브젝트. --reload: 코드 변경 후 서버 재시작. 개발에만 사용.

참고: https://fastapi.tiangolo.com/ko/tutorial/first-steps/

첫걸음 - FastAPI

 

 

출처: https://ete-llorona.tistory.com/13