main.py

from fastapi import FastAPI

app = FastAPI()

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

다음과 같이 main.py를 구성

run server

uvicorn main:app --reload

• main: 실행시킬 파일 (main.py)
• app: 실행시킬 파일 내에서 생성된 객체 ( app = FastAPI() )
• —reload: 코드에 변경사항이 생기면 서버를 재시작하는 옵션 (오직 개발계에서만 사용해야 된다.)

그 후, 다음과 같은 커맨드로 서버를 시작. 그러면 아래와 같은 메세지가 뜬다. 이 메세지는 local machine에서 app이 제공하는 URL을 나타낸다.

INFO:     Uvicorn running on <http://127.0.0.1:8000> (Press CTRL+C to quit)

API docs

• URL/docs (스웨거)

  • 자동으로 생성된 상호적인 API문서를 볼 수 있다.

  

• URL/redoc (리독)

  • 자동으로 생성된 대안적인 API문서를 볼 수 있다.

  

OpenAPI

FastAPI는 API를 정의하기 위한 OpenAPI ****표준을 사용하여 모든 API에 "스키마"를 생성한다.

Schema

• 무언가의 추상적인 정의 혹은 설명