[FastAPI] 경로 작동 설정

 

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

 

경로 작동 데코레이터에 설정할 수 있는 매개변수들이 있다.

 

이전 포스트에서 설명한 응답 상태 코드(status_code) 같은 것이다.

[FastAPI] Form

 

tag

str로 구성된 list와 함께 매개변수 tags를 전달하여, 경로 작동에 태그를 추가할 수 있다.

from fastapi import FastAPI

app = FastAPI()

@app.get('/items', tags=['item'])
def getItems():
    return {"items": [1, 2, 3, 4]}

@app.post('/items', tags=['item'])
def postItem():
    return {"item": 3}

@app.get('/users', tags=['user'])
def getUser():
    return {"User": "pupba"}

 

 

Summary and Description

summary(요약), description(기술)로 매개변수로 요약과 기술을 추가할 수 있다.

from fastapi import FastAPI

app = FastAPI()


@app.get('/items',
         tags=['item'],
         summary="Get Items",
         description="Request '/items' get Items....")
def getItems():
    return {"items": [1, 2, 3, 4]}

 

마크다운으로 Docstring을 작성할 수 있다.

from fastapi import FastAPI

app = FastAPI()

@app.get('/items',
         tags=['item'],
         summary="Get Items")
def getItems():
    """
    Request '/items' get Items
    - {**items** : List}
    """
    return {"items": [1, 2, 3, 4]}

 

 

Response Description

response_description을 통해 응답 내용도 기술 할 수 있다.

from fastapi import FastAPI

app = FastAPI()


@app.get('/items',
         tags=['item'],
         summary="Get Items",
         response_description="Response Json: dictionary key-'items' and value-'List'")
def getItems():
    """
    Request '/items' get Items
    - {**items** : List}
    """
    return {"items": [1, 2, 3, 4]}

 

 

Deprecated

단일 경로 작동을 없애지 않고 지원중단을 해야한다면 deprecated 매개변수를 True로 하면된다.

from fastapi import FastAPI

app = FastAPI()


@app.get('/items',
         tags=['item'],
         summary="Get Items",
         response_description="Response Json: dictionary key-'items' and value-'List'",
         deprecated=True)
def getItems():
    """
    Request '/items' get Items
    - {**items** : List}
    """
    return {"items": [1, 2, 3, 4]}