🌈 PyCharm으로 시작하는 FastAPI 개발 여정 (초보자를 위한 가이드) 1편 ✨

안녕하세요 여러분! 오늘부터 개발 초보자도 쉽게 따라할 수 있는 PyCharm과 FastAPI 조합으로 웹 API 개발하는 방법을 알아볼게요! 🚀 이 시리즈는 총 4편으로 구성되어 있어요. 차근차근 따라오시면 여러분도 멋진 API를 만들 수 있을 거예요!

🔍 이 포스팅 시리즈에서 배울 내용

1. 1편: 환경 설정과 기본 개념 (지금 이 글!)
2. 2편: 첫 번째 API 엔드포인트 만들기
3. 3편: 데이터베이스 연결과 CRUD 작업
4. 4편: 배포와 문서화

🛠️ PyCharm과 FastAPI란 무엇인가요?

PyCharm은 JetBrains에서 개발한 파이썬 개발을 위한 통합 개발 환경(IDE)이에요. 코드 작성, 디버깅, 테스트를 한 곳에서 할 수 있어서 개발 초보자도 쉽게 사용할 수 있답니다! 😊

FastAPI는 현대적이고 빠른 웹 프레임워크로, 파이썬 3.6+ 버전에서 API를 쉽게 만들 수 있게 도와줘요. 특히 자동 문서화 기능이 뛰어나서 API를 개발하면서 동시에 문서도 자동으로 생성해준답니다! 💯

🚀 1단계: 필요한 도구 설치하기

PyCharm 설치하기

1. PyCharm 공식 웹사이트에서 Community 버전(무료)을 다운로드하세요.
2. 다운로드한 설치 파일을 실행하고 안내에 따라 설치를 완료하세요.
3. PyCharm을 실행해보세요! 🎉

Python 설치하기

1. Python 공식 웹사이트에서 Python 3.7 이상 버전을 다운로드하세요.
2. 설치 시 "Add Python to PATH" 옵션을 체크하는 것 잊지 마세요! ⚠️
3. 설치가 완료되면 명령 프롬프트(윈도우) 또는 터미널(맥/리눅스)에서 python --version 명령어로 제대로 설치됐는지 확인해보세요.

🌱 2단계: 새 프로젝트 만들기

자, 이제 PyCharm에서 FastAPI 프로젝트를 시작해볼까요? 😃

1. PyCharm을 실행하고 "New Project"를 클릭하세요.
2. 프로젝트 이름을 fastapi-tutorial로 지정하세요.
3. "Create a new Python virtual environment"를 선택하세요. 가상환경은 프로젝트마다 독립적인 파이썬 환경을 만들어주어 패키지 충돌을 방지해준답니다!
4. "Create" 버튼을 클릭하면 새 프로젝트가 생성됩니다. 🎈

💻 3단계: 필요한 패키지 설치하기

이제 프로젝트에 필요한 패키지들을 설치할 차례에요! PyCharm의 터미널에서 다음 명령어를 입력해주세요:

pip install fastapi uvicorn

여기서 fastapi는 우리가 사용할 웹 프레임워크이고, uvicorn은 FastAPI 애플리케이션을 실행할 ASGI 서버예요. 🔧

🎯 4단계: 첫 FastAPI 애플리케이션 만들기

자, 이제 첫 번째 FastAPI 애플리케이션을 만들어볼게요! 😍

1. 프로젝트 루트 디렉토리에 main.py 파일을 생성하세요.
2. 다음 코드를 입력해보세요:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"message": "안녕하세요! FastAPI 세계에 오신 것을 환영합니다! 🎉"}

이 코드는 정말 간단하죠? FastAPI를 불러오고, 애플리케이션 인스턴스를 생성한 다음, 루트 경로("/")에 대한 GET 요청 핸들러를 정의했어요. 이 핸들러는 간단한 JSON 메시지를 반환합니다! 🙌

🚀 5단계: 애플리케이션 실행하기

이제 우리의 첫 FastAPI 애플리케이션을 실행해볼까요? PyCharm 터미널에서 다음 명령어를 입력하세요:

uvicorn main:app --reload

여기서 main은 우리가 작성한.py 파일 이름이고, app은 그 파일 안에 있는 FastAPI 인스턴스 변수명이에요. --reload 옵션은 코드가 변경될 때마다 서버를 자동으로 재시작하게 해줍니다. 개발 중에 아주 편리하죠! 😉

명령어를 실행하면 다음과 같은 메시지가 표시될 거예요:

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [xxxx] using statreload
INFO:     Started server process [xxxx]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

웹 브라우저를 열고 http://127.0.0.1:8000로 접속해보세요. 우리가 작성한 메시지가 JSON 형식으로 표시될 거예요! 🎊

📚 FastAPI의 자동 문서화 기능

FastAPI의 멋진 기능 중 하나는 자동 문서화 기능이에요! 브라우저에서 다음 URL로 접속해보세요:

• http://127.0.0.1:8000/docs: Swagger UI 기반 API 문서
• http://127.0.0.1:8000/redoc: ReDoc 기반 API 문서

직접 만들지 않았는데도 전문적인 API 문서가 자동으로 생성되었죠? 이게 바로 FastAPI의 강점이랍니다! 😲

🎁 마무리

오늘은 PyCharm과 FastAPI를 이용한 기본 환경 설정과 첫 번째 애플리케이션을 만들어보았어요! 이제 여러분들도 웹 API 개발의 첫 걸음을 내딛었네요! 👏

다음 2편에서는 더 다양한 엔드포인트를 만들고, 경로 매개변수, 쿼리 매개변수, 요청 본문 등을 다루는 방법을 알아볼 예정이에요. 기대해주세요! 💕

👩‍💻 배워볼 키워드 미리보기

• 경로 및 쿼리 매개변수 다루기
• Pydantic 모델을 이용한 데이터 검증
• 요청 본문(Request Body) 처리하기
• 응답 모델 정의하기

궁금한 점이나 질문이 있으시면 댓글로 남겨주세요! 다음 글에서 만나요~ 😊🌟