๐ฐ FastAPI ๊ณต์๋ฌธ์๋ฅผ ๋ณด๋ฉด์ ๊ฐ์ธ์ ์ผ๋ก ์ ๋ฆฌํ ๊ธ ์
๋๋ค.
๊ฒฝ๋ก ์๋ ๋ฐ์ฝ๋ ์ดํฐ์ ์ค์ ํ ์ ์๋ ๋งค๊ฐ๋ณ์๋ค์ด ์๋ค.
์ด์ ํฌ์คํธ์์ ์ค๋ช ํ ์๋ต ์ํ ์ฝ๋(status_code) ๊ฐ์ ๊ฒ์ด๋ค.
[FastAPI] Form
๐ฐ FastAPI ๊ณต์๋ฌธ์๋ฅผ ๋ณด๋ฉด์ ๊ฐ์ธ์ ์ผ๋ก ์ ๋ฆฌํ ๊ธ ์ ๋๋ค. ์๋ต์ํ HTTP์์๋ ์๋ต์ํ์ ๋ฐ๋ผ ์ํ์ฝ๋๋ฅผ ๋ฐํํ๋ค. FastAPI์์๋ status_code ๋งค๊ฐ๋ณ์๋ฅผ ์ฌ์ฉํ์ฌ ์๋ต์ ๋ํ HTTP ์ํ ์ฝ๋๋ฅผ
pupbani.tistory.com
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]}
'Back-end & Server > FastAPI' ์นดํ ๊ณ ๋ฆฌ์ ๋ค๋ฅธ ๊ธ
[FastAPI] Relational Database (0) | 2024.02.22 |
---|---|
[FastAPI] ๋ฏธ๋ค์จ์ด (0) | 2024.02.20 |
[FastAPI] Form (0) | 2024.02.20 |
[FastAPI] ๋ชจ๋ธ (0) | 2024.02.20 |
[FastAPI] ๋งค๊ฐ๋ณ์ (0) | 2024.02.20 |