FastAPI로 만드는 웹 앱 - 기본

11417 단어 파이썬 asyncio

파이썬에서 Asyncio를 사용한 비동기 프로그래밍을 추구해 온 결과 FastAPI에 부딪혔습니다. Python계에 있어서는 현대적인 Web Framework라고 하는 것으로 인기인 것 같습니다. 조금 조사해 가고 싶습니다.

【과거 기사】
Python Asyncio 입문
Aiohttp로 만드는 Simple Web Server - Qiita
Starlette로 만들기 Simple Web Server - QIita
FastAPI로 만드는 웹 앱 - 기본
FastAPI로 만드는 웹 앱 - validation
FastAPI로 만드는 웹 앱 - Body validation
FastAPI로 만드는 웹 앱 - Form validation

FastAPI 공식 사이트

다음 정보는 공식 사이트 튜토리얼의 첫 단계를 간략하게 요약한 것입니다.

1. 헤일로 월드

설치는 다음 명령으로만 수행할 수 있습니다.

pip install fastapi[all]

간단한 헬로 월드 프로그램을 보여줍니다.

main.py

from fastapi import FastAPI

app = FastAPI() # FastAPIはStarletteを直接継承するクラスです。


@app.get("/")  # デコレーション、パス= /, オペレーション = get
async def root():
    return {"message": "Hello World"} # コンテンツの生成

FastAPI는 Starlette를 직접 상속하는 클래스입니다. FastAPI에서도 Starlette의 모든 기능을 사용할 수 있습니다.
Starlette로 만드는 Simple Web Server

다음 명령으로 앱을 시작할 수 있습니다.

uvicorn main:app --reload

다음은 시작 명령 설명

main: main.py 파일(Python "module").

app: main.py 내부에서 만들어지는 object (app = FastAPI() 와 같이 기술된다).

--reload: 코드를 변경할 때 서버를 다시 시작합니다. 개발용.

시작 메시지입니다.

$uvicorn main:app --reload
INFO:     Will watch for changes in these directories: ['C:\\Users\\User\\git\\python\\asyncio\\fastapi']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [12544] using watchgod
INFO:     Started server process [12916]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

메시지에 따라 브라우저에서 http://localhost:8000에 액세스하면 다음 콘텐츠를 받게됩니다.

{"message": "Hello World"}

대화형 API 문서

지금까지의 조작만으로, 다음과 같은 문서가 자동 생성됩니다. Swagger UI에서 구현되며 RESTful API의 사양이며 실제로 Request를 발행 할 수 있습니다. 개발 효율에 크게 기여하는 것입니다.
http://localhost:8000/docs

Try it out 버튼을 클릭하면 아래와 같이 Execute 버튼이 나타납니다.

이 경우 매개 변수가 없으므로 그대로 "Execute"버튼을 클릭하면 요청이 발행됩니다.

발행된 요청과 결과의 응답이 표시됩니다. 매우 편리합니다. 다음으로 매개 변수가있는 Request에 대해보고 싶습니다.

2. 파라미터

다음으로 경로 매개 변수, 쿼리 매개 변수, 요청 본문을 받는 방법과 Swagger UI를 사용하여 확인하는 방법을 살펴 보겠습니다.

param.py

from fastapi import FastAPI

app = FastAPI()

###############################
### パスパラメータ
###############################
@app.get("/items/{item_id}")
async def read_item(item_id : int):
    return {"item_id": item_id}


###############################
### クエリパラメータ
###############################
fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]

@app.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):
    return fake_items_db[skip : skip + limit]



###############################
### リクエストボディ
###############################
from typing import Optional
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None

@app.post("/items/")
async def create_item(item: Item):
    return item