[HTTP / 강의] API URI 설계

URI (Uniform Resource Identifier)

• 회원 목록 조회 /read-member-list
• 회원 조회 /read-member-by-id
• 회원 등록 /create-member
• 회원 수정 /update-member
• 회원 삭제 /delete-member

 

 

이것은 좋은 URI 설계일까??
가장 중요한 것은 🌟 리소스 식별!! 🌟

 

 

 

API URI 고민

🤔 리소스의 의미는 뭘까?

• 회원을 등록하고 수정하고 조회하는 것이 리소스가 아니다!
• ex ) 미네랄을 캐라 -> 미네랄이 리소스
• 회원이라는 개념 자체가 바로 리소스.

🤔 리소스를 어떻게 식별하는 것이 좋을까?

• 회원을 등록하고 수정하고 조회하는 것을 모두 배제
• 회원이라는 리소스만 식별하면 된다 ! 👉 회원 리소스를 URI에 매핑

 

 

API URI 설계

🌟 리소스 식별, URI 계층 구조 활용

• 회원 목록 조회 /members
• 회원 조회 /members/{id}
• 회원 등록 /members/{id}
• 회원 수정 /members/{id}
• 회원 삭제 /members/{id}

✔️ 계층 구조 상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

 

 

⚠️ 위 조회, 등록, 수정, 삭제를 어떻게 구분하지??

 

 

---

 

 

리소스와 행위를 분리!

🌟 가장 중요한 것은 리소스를 식별하는 것이다.

• URI는 리소스만 식별!
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원
  • 행위 : 조회, 등록, 수정, 삭제
• 리소는 명사, 행위는 동사
• 행위(메서드)는 어떻게 구분하지?

 

💡 HTTP 메서드를 이용하여 구분!

 

 

 

 

👇 아래 강의를 참고하여 작성한 글입니다

모든 개발자를 위한 HTTP 웹 기본 지식 강의 - 인프런