[HTTP] API설계 예시로 알아보는 URI 설계 개념(컬렉션,스토어,컨트롤URI)

POST기반 API설계

회원 관리 시스템 

회원등록을 POST로 한다.

• 클라이언트는 등록될 리소스의 URI를 모른다 

             -회원등록 /members ->POST

 

• 서버가 새로 등록된 리소스 URI를생성해준다.

HTTP/1.1 201 Created
 Location:/members/100

 

컬렉션이란?

• 서버가 관리하는 리소스 디렉토리이다.
• 서버가 리소스의 URI를 생성하고 관리한다.
• 위예에서 /members가 컬렉션이다.

 

PUT 기반 API 설계

파일관리리스템

 

파일등록을 PUT이용

• 클라이언트가 리소스 URI를 알고있어야 한다.

           - 파일등록 /files/{filename} -> PUT

           - PUT /files/star.jpg

 

• 클라이언트가 직접 리소스의 URI를 지정한다.

스토어?

• 클라이언트가 관리하는 리소스 저장소이다.
• 클라이언트가 리소스의 URI를 알고 관리한다.
• 위 예시에서 스토어는 /files이다.

 

HTML Form태그 사용 예시

• HTML FORM은 GET,POST만 지원한다. 그렇기 때문에 제약이 있다.
• 실무에서는 HTML FORM으로 해결못하는 경우, HTML에서 Form전송 대신 js를 통한 AJAX같은 기술을 사용해서 해결가능하다.
• 아래예제는 순수 HTML, HTML FORM의 경우를 나타낸다.

컨트롤 URI 

• GET, POST만 지원하므로 제약이 있기때문에 이때 사용하는것이 컨트롤 URI이다.
• 컨트롤 URI는 동사로 된 리소스 경로를 사용한다

           - /new, /edit, /delete

• HTTP 메소드(GET,POST, 등)만으로 해결하기 애매한 경우 사용한다.

---

참고하면 좋은 URI설계 개념

---

문서(document)

• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
• 예) /members/100, /fiels/star,jpg

 

컬렉션

• 서버가 관리하는 리소스 디렉토리
• 서버가 리소스의 URI를 생성하고 관리
• /members

 

스토어

• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• /files/{filename}

컨트롤러, 컨트롤 URI

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행 -> 데이터조작 데이터변경 등과같이
• 동사를 직접 사용
• URI에 리소스와 http 메소드 만을 최대한 이용해야하지만 실무에서는 그대로 안되는 경우가 태반이고 이럴때 사용한다.
• /members/{id}/delete 여기서 /delete가 컨트롤 URI이다. 

 

 

 

https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard

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