URL Parameters

FastAPI 사용법을 알아보기에 앞서 URL Parameters에 대해 알아보자.

웹에서 GET Method를 사용해서 데이터를 전송할 수 있다.

그런데 이 URL Parameters 전송하는 방법은 2가지 방식으로 나뉜다.

 

(1) Path Parameter 방식

• /usrs/402
• 서버에 402라는 값을 전달하고 변수로 사용한다는 것

 

(2) Query Parameter 방식

• /users?id=402
• Query String이라고도 하며, API 뒤에 입력 데이터를 함께 제공하는 방식이다.
• Query String은 Key와 Value로 이뤄지며 &를 통해 여러 데이터를 넘길 수도 있다.

 

(3) 어떤 방식을 사용해야할까?

어떤 Resource를 식별하고 싶을 때, 'A'라는 이름의 유저가 없는 경우

• Path:
  • /users/A
  • 존재하지 않으므로 404 Error
• Query:
  • /users?name=A
  • 데이터가 없는 경우, Optional이기 때문에 빈 리스트가 나온다.
  • 이건 데이터가 없는 것이므로 예외처리 등이 필요하므로 추가적인 Error Handling이 필요하다.

따라서 다음과 같이 생각하면 된다.

• Resource를 식별해야 할 때 : Path 가 더 적합
• 정렬, 필터링이 필요할 때 : Query 가 더 적합