[FastAPI] Metadata Docs, Testing, Debugging

 

🐰 FastAPI 공식문서를 보면서 개인적으로 정리한 글 입니다.

 

Metadata Docs

/docs로 접속했을 때 나오는 Swagger UI 페이지에 Metadata를 추가할 수 있다.

FastAPI()에 매개변수를 전달하면 된다.

Parameter	Type	Description
title	str	API의 제목
summary	str	API 요약
description	str	API 설명
version	string	API 버전
terms_of_service	str	API의 약관의 URL
contact	dict	API 관련 연락정보, fields -> (name:str, url:str, email:str)
license_info	dict	API 관련 라이센스 정보, fields -> (name:str, identifier:str, url:str)

 

from fastapi import FastAPI, Request
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates

description = """
Jinja2 Template & Static Test. 🎈

## Template 
Use -> **Jinja2Templates()**

## Static
Use -> StaticFiles()

Thank You..!
"""

app = FastAPI(
    title="Jinja2Template & Static Test App",
    description=description,
    summary="I like FastAPI...",
    version="0.0.1",
    terms_of_service="http://example.com/terms/",
    contact={
        "name": "Pupba",
        "url": "http://x-force.example.com/contact/",
        "email": "pupba13@x-force.example.com"
    },
    license_info={
        "name": "MIT",
        "url": "https://opensource.org/license/mit"
    }
)

app.mount("/static", StaticFiles(directory="static"), name="static")


templates = Jinja2Templates(directory="templates")


@app.get("/items/{id}", response_class=HTMLResponse)
async def read_item(request: Request, id: str):
    return templates.TemplateResponse(
        request=request, name="index.html", context={"id": id}
    )

 

 

매개변수로 url을 전달해 openapi.json에 대한 경로를 임의로 변경할 수 있다.

app = FastAPI(openapi_url="/api/v1/openapi.json")

 

/docs와 /redoc 페이지를 없애거나 임의의 주소로 변경할 수 있다.

app = FastAPI(docs_url="/documentation", redoc_url=None)
# None의 경우 페이지 비활성화

 

 

Testing

fastapi의 TestClient를 사용해 엔드포인트 동작을 테스트할 수 있다.

TestClient는 httpx를 기반으로 작성되었기 때문에 httpx를 설치해야 한다.

pip install httpx

 

main.py

from typing import Dict
from fastapi import FastAPI, Request
from fastapi.staticfiles import StaticFiles


app = FastAPI()


@app.get("/items/{id}", response_model=Dict[str, str])
async def read_item(id: str):
    return {"id": id}


@app.get("/item/{item}", response_model=Dict[str, str])
async def get_item(item: str):
    return {"Item": item}

 

Testing file - /tests/test_main.py

from fastapi.testclient import TestClient

from ..main import app

client = TestClient(app)


def test_read_item():
    response = client.get('/items/foo')
    assert response.status_code == 200
    assert response.json() == {"id": "foo"}


def test_read_item_bad():
    response = client.get('/items/')
    assert response.status_code == 404
    assert response.json() == {"detail": "Not Found"}


def test_get_item():
    response = client.get('/item/foo')
    assert response.status_code == 200
    assert response.json() == {"Item": "foo"}


def test_get_item_bad():
    response = client.get('/item/')
    assert response.status_code == 404
    assert response.json() == {"detail": "Not Found"}

 

이제 pytest를 설치하고 test를 할 수 있다.

pip install pytest

 

* pytest를 실행할 때는 /app/... 같이 파일들이 패키지로 묶여있어야 함, (테스트 정의 파일 제외)파일이나 패키지 이름에 test 관련되 이름이 안들어가게 조심!

pytest

 

이렇게 API들을 테스트 해볼 수 있다.

 

 

Debugging

uvicorn을 사용해서 FastAPI App을 실행할 수 있다.

실행 포트, 주소 등을 설정할 수 있다.

from typing import Dict
from fastapi import FastAPI
import uvicorn


app = FastAPI()


@app.get("/items/{id}", response_model=Dict[str, str])
async def read_item(id: str):
    return {"id": id}


@app.get("/item/{item}", response_model=Dict[str, str])
async def get_item(item: str):
    return {"Item": item}

if __name__ == "__main__":
    uvicorn.run(app, host="127.0.0.1", port=8080)

 

IDE의 Debug 기능으로 Debugging을 수행할 수 있다.