FastAPI로 처음 웹에 데이터 띄워보기 ( pip, .venv )

1. CMD로 파이썬 버전 확인 

 

python --verison 에서 버전이 안나오면, 제대로 설치된게 아니다.

제어판가서 파이썬 삭제하고, 다시 설치할 때,

"Add Python to PATH" 이거 체크하고 설치하자.

 

2. venv 가상환경 생성

python -m venv .venv

이렇게 cmd에 명령어를 입력하면 .venv 파일이 생성된다.

.venv는 가상환경을 만드는 명령어이다. ( 프로젝트마다 다른 버전의 라이브러리를 설치해야 할 때 충돌 없이 사용하려고 만듬 )

 

 

3. FastAPI 프레임워크 설치

pip install fastapi

이거는 FastAPI라는 웹 프레임워크를 설치하라는 명령어이다.

즉, 파이썬에서 FastAPI라는 라이브러리를 사용할 수 있게 만들어 준다.

pip list를 통해서 fastapi가 설치 된 것을 확인할 수 있다.

 

4. FastAPI를 실행하는 ASGI서버 설치

pip install uvicorn
pip install fastapi "uvicorn[standard]"

uvicorn은 FastAPI를 실행하는 서버프로그램 (ASGI 서버)이다. 즉 , FastAPI앱을 띄워주는 엔진이 uvicorn이다.

 

pip install fastapi "uvicorn[standard]"

이거는 fastapi 본체, uvicorn[standard]까지 두 가지를 한번에 설치하는 명령이다.

uvicorn[standard]는 확장기능을 같이 설치하는 버전이다.

( uvloop - 더 빠른 이벤트 루프, httptools - 빠른 HTTP 파서, websockets - 웹소켓 지원 )

 

실제로는 pip install uvicorn만 있어도 충분하긴하다.

 

pip freeze > requirements.txt  명령어를 통해서 설치 한 파일 리스트를 저장 할 수 있다. 

 

 

5. VisualStudio에서 예제 코딩

visual studio에서 main.py를 만들어서 코딩을 간단하게 해보았고, 

from typing import Union
from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "wolrd"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

 

 

6. 서버 실행

uvicorn main:app --reload

cmd에서 이거를 서버를 통해서 실행시켜보았다. (main.py 파일 안에 있는 app 객체를 실행해라 라는 명령어.)

FastAPI로 만든 API서버를 켜는 스위치인 것이다. FastAPI에는 반드시 FastAPI)로 만든 객체가 하나 있어야한다.

 

꼭 저렇게 길게 안치게 하려면, run.bat을 별도로 만들어서 cmd창에 run만 쳐도 된다.

작업 끝낼 경우에는 Ctrl + c 를 입력하면 된다.

 

 

7. URL 서버 확인

 

Uvicorn에서 보이는 http://127.0.0.1:8000   링크로 가게되면  이렇게 json형태로 데이터가 나오는 것을 확인할 수 있다.

get 주소를 통해서 이렇게 데이터를 넣어줄 수도 있다.

 

 

8. Docs와 ReDoc

AP문서는 자동으로 생성이 된다. redoc과 docs에 대해서도 한번 들어가보자.

 

• Swagger UI: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redoc

 

1) 핵심 차이 한 줄 요약

• Swagger UI (/docs): 개발·테스트에 최적화. “Try it out”으로 바로 요청을 보내어 API를 시험해볼 수 있음. UI가 인터랙티브하고 사용성이 좋음.
• ReDoc (/redoc): 문서 읽기에 최적화. 깔끔한 사이드바, 긴 설명과 스키마를 보기 좋게 정리. 기본적으로 SwaggerUI만큼 인터랙티브하지는 않음.

 

 

이렇게 python을 이용해서 fastApi 환경에서 웹에 한번 띄워보았다.

fastAPI는 처음이기도하고, 파이썬으로 웹을 구동하는것도 생소해서 한번 취미로 배워보려고한다.