[FastAPI] FastAPI이용한 백엔드 구축 가이드라인 (2) parameter

 

1. URL과 Parameters

 

1.1 URL 구성요소

 

1.2 Parameters

 

Query Parameters는 URL에서 데이터를 전달하는 방법 중 하나입니다.
웹 API에서 클라이언트가 서버에 데이터를 요청할 때, 경로 뒤에 ?를 붙이고 key=value 형식의 쿼리 문자열을 사용하여 추가 데이터를 보낼 수 있습니다.

 

📌 Query Parameters 구조

/func?key1=val1&key2=val2​

• func → 실행할 함수(엔드포인트)
• ? → 쿼리 매개변수(Query Parameters) 시작
• key1=val1 → 첫 번째 매개변수 (key1의 값은 val1)
• & → 여러 개의 매개변수를 연결할 때 사용

📌 Python 코드에서 활용

def func(key1, key2): 
	result = doSomethingWithValuesOf(key1, key2) 
   	return result

 

• key1, key2 → 함수의 매개변수 (Query Parameters에서 전달받은 값)
• doSomethingWithValuesOf(key1, key2) → 받은 값을 활용하여 처리 수행

 

 

1.3 FastAPI에서의 Parameters

 

from fastapi import FastAPI

app = FastAPI()

@app.get("/func")
def read_items(key1: str, key2: str):
    return {"key1": key1, "key2": key2}

 

➡️ 요청 예시

GET /func?key1=hello&key2=world

 

➡️ 응답 예시 (JSON)

{
    "key1": "hello",
    "key2": "world"
}