Modern

[FastAPI] 01. 개발환경 설정 본문

Study/FastAPI

[FastAPI] 01. 개발환경 설정

네칼림 2024. 3. 30. 19:34

 

Windows - FastAPI 개발환경 설정

파이썬 관련 개발에서 가장 많이 쓰이는 툴은 pycharm 과 vscode 일 것이다. 파이썬에 특화된 개발, 또는 초심자는 pycharm(파이참) 이 좋다고 생각하기 때문에, pycharm 으로 개발 환경을 설정한다. 링크는 아래와 같다.

 

PyCharm 다운로드: 데이터 과학 및 웹 개발을 위해 JetBrains가 만든 Python IDE

 

PyCharm 다운로드: 데이터 과학 및 웹 개발을 위해 JetBrains가 만든 Python IDE

 

www.jetbrains.com

파이참 프로젝트 설정

파이참을 설치했으면, 새 프로젝트를 만들고 파이썬 가상환경을 생성한다. 파이참을 수행하면 아래와 같은 화면이 나오는데, New Project 를 클릭한다.

 

 

 

다음은 프로젝트 생성 시 파이썬 가상환경에 대한 설정 부분이다. Name 및 Location은 프로젝트 설치를 원하는 경로이다. 그 아래 부분은 파이썬 및 가상환경에 대한 설정 부분으로, 비교적 최신 버전은 3.10 버전으로 설정한다. 작성이 완료되었으면 Create 버튼 클릭.

 

설정 후 필수 패키지를 설치하기 위해 파이참 내에서 터미널을 열어준다. 단축키는 Alt+F12로 좌측 하단의 >_ 모양을 클릭해도 열 수 있다. 파이참 하단에 아래와 같은 창이 열린다.

 

다음은 터미널에서 fastapi 관련 패키지를 설치하기 위한 명령어이다. 우선 2가지를 먼저 설치한다.

  pip install fastapi
  pip install uvicorn

 

이제 정상적으로 환경 설정이 완료되었는지 확인하기 위한 코드 작성이다. main.py의 내용을 모두 삭제하고 아래와 같이 작성한다.

# main.py
from fastapi import FastAPI  

app = FastAPI()  


@app.get("/")  
def hello_world():  
    return "hello_world"

 

다음은 테스트를 위한 FastAPI 서버를 실행한다. 터미널에 다음 명령어를 입력한다.

uvicorn main:app

 

위와 같이 입력하면 FastAPI 서버가 디폴트로 8080 포트로 생성되며, localhost:8000 로 접속을 시도하면 다음과 같은 화면을 볼 수 있다.

 

FastAPI - Swagger UI 로 들어가게 되면 다음과 같은 화면을 볼 수 있다. Swagger UI 라고 하는 이 화면은 FastAPI에서 각 API의 기능 테스트에 상당히 많이 쓰인다. hello world 의 우측을 클릭하여 펼친 후 Try it out > Execute 를 클릭하면 아래와 같은 화면을 확인 할 수 있다.

 

이상으로 기본적인 개발환경을 모두 작성하였다. 다음은 Select, Insert, Update, Delete 기능을 구현해본다.