FastAPI 목차
주의사항
- FastAPI 모던 파이썬 문법을 사용하기에 3.6 이상의 파이썬이 설치가 되어야 한다.
> python -V
# 혹은
> python --version
위의 명령어를 입력했을때 Python 버전이 3.6 이상이면 FastAPI를 설치하는데 문제가 없다
프로젝트 생성
(원하는 곳에 이동하여) 프로젝트를 진행할 디렉터리를 생성합니다.
> mkdir fastapi
> cd fastapi
디렉터리를 생성했다면, 가상 환경을 만들어줍니다.
(Pycharm을 이용하여 프로젝트를 생성 시 자동으로 만들어 주는 것 같습니다...)
# python -m venv {directory}
> python -m venv venv
# venv를 생성하는곳을 venv로 동일하게 했습니다,
# 이름을 동일하게 하지 않아도 무방하나 일반적으로 많이 사용합니다
> source venv/bin/activate
# activate가 안 될 경우
> source venv/Scripts/activate
가상 환경이 설치되었는지 확인하기
> which python
위와 같은 명령어를 기입시, 생성한 디렉터리의 venv의 python을 가리킨다면 가상 환경 설정이 완료되었습니다.
> pip install fastapi
명령어를 기입해서 FastAPI를 설치합니다.
코드 작성하기
기존에 사용하고 있던 IDE를 이용하여 코드를 작성합니다.
필자는 PyCharm을 이용하여 작성하도록 하겠습니다.
위에서 만든 폴더를 IDE에 켠 뒤 , main.py를 만듭니다.
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def hello():
return "Hello, World!"
main.py에 해당 코드를 기입합니다.
코드 실행하기
- FastAPI는 개발용 내장 서버가 없기에, 서버를 이용해 실행하기 위해서는 Uvicorn을 설치하여 실행합니다.
(Uvicorn이 아닌 Hypercorn을 이용해서 실행시킬 수 도 있습니다)
> pip install uvicorn
Uvicorn 설치 후 아래의 명령어를 입력 시 서버가 실행됩니다.
> uvicorn main:app --reload
INFO: Started server process [11248]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
127.0.0.1:8000으로 접속 시 아래와 같이 main.py에 기입한 Hello World를 확인할 수 있습니다.
"127.0.0.1:8000/docs"을 주소창에 입력한다면 Swagger를 확인 할 수 있습니다.
Swagger의 장점은, 해당 RestFul을 실행시켜 볼 수 있습니다.
"127.0.0.1:8000/redoc"을 주소창에 입력한다면 OpenAPI를 확인할 수 있습니다.
'Programming > Python' 카테고리의 다른 글
[FastAPI] 응답 모델 (0) | 2022.08.13 |
---|---|
[FastAPI] 요청 본문 (0) | 2022.08.12 |
[FastAPI] 쿼리 매개변수 (0) | 2022.08.11 |
[FastAPI] 경로 매개변수 (0) | 2022.08.10 |
[FastAPI] FastAPI 소개 (0) | 2022.08.08 |