API에서 URL의 작성 관례

백엔드 개발을 하다 보면, URL을 작성하게 됩니다.

그런데 내 맘대로 작성하게 되면 팀원들끼리 URL에 오타가 나거나 헷갈려 url 을 까먹고 다시 찾아보다가 생산성이 느려질 수 있는데요

 

API의 URL은 일반적으로 몇 가지 기본 규칙과 관례를 따르며 작성됩니다.

그러나 모든 조직이나 개발팀이 동일한 규칙을 따르지는 않기 때문에, 특정 API의 URL 패턴은 해당 API를 개발한 조직의 스타일 가이드와 정책에 따라 달라질 수 있습니다.

 

일반적으로 API URL은 아래와 같은 패턴을 따릅니다.

 

• API의 버전 : 이는 /v1/, /v2/ 등의 형태로 나타내며, API가 버전 Up할 때 이전 API를 사용하는 서비스가 계속 작동하도록 보장하기 위해 중요합니다. 

https://api.eduenv.com/v1/

 

• 리소스나 컬렉션의 이름 : 이 부분은 API가 다루는 데이터의 유형을 나타내며, 대개 복수형 명사로 표현합니다. 그리고 주로 동사보다는 명사를 사용해요!

https://api.eduenv.com/v1/users/

 

• 특정 리소스의 식별자 : 리소스의 구체적인 인스턴스를 지정하는 데 사용되며, 일반적으로는 리소스의 고유 ID를 나타냅니다.

https://api.eduenv.com/v1/users/123/

• 서브 리소스 : 특정 리소스와 관련된 추가 리소스를 지정하는 데 사용됩니다.

https://api.eduenv.com/v1/users/123/orders/

• 쿼리 파라미터 : URL의 끝에? 다음에 키-값 쌍으로 추가되며, 필터, 페이징, 정렬 등의 작업을 수행하는 데 사용됩니다.

https://api.eduenv.com/v1/users/123/orders?sort=desc&page=2

 

 

이러한 패턴들은 URL을 구성하는 방법에 대한 일반적인 지침이며, RESTful 디자인 원칙을 따르는 경우에 가장 흔히 사용됩니다. 

 

 

 

 

 

그럼 20000 즐겁게 코딩하세요!