[모든 개발자를 위한 HTTP 웹 기본 지식] HTTP 메서드 활용 - HTTP API 설계

HTTP API - 컬렉션

• 회원 관리 시스템 API 설계 예시 - POST 기반 등록
  • 회원 목록 /members
    • GET
  • 회원 등록 /members
    • POST
  • 회원 조회 /members/{id}
    • GET
  • 회원 수정 /members/{id}
    • PATCH : 일부만 수정해야하는 경우
    • PUT : 전체를 수정해야하는 경우(게시물 수정)
    • POST : 애매한 경우 사용
  • 회원 삭제 /members/{id}
    • DELETE

 

• POST - 신규 자원 등록 특징
  • 클라이언트는 등록될 리소스의 URI를 모른다.
    • 회원 등록 /members
      • POST
    • 전송형태 : POST /members
  • 서버가 새로 등록된 리소스 URI를 생성해준다.
    • HTTP/1.1 201 Created Location: /members/100
  • 컬렉션(Collection)
    • 이러한 형태의 관리를 컬렉션이라고 불린다.
    • 서버가 관리하는 리소스 디렉토리
    • 서버가 리소스의 URI를 생성하고 관리
    • 여기서 컬렉션은 /members

 

HTTP API - 스토어

• 파일 관리 시스템 API 설계 예시 - PUT 기반 등록
  • 파일 목록 /files
    • GET
  • 파일 조회 /files/{filename}
    • GET
  • 파일 등록 /files/{filename}
    • PUT
  • 파일 삭제 /files/{filename}
    • DELETE
  • 파일 대량 등록 /files
    • POST

 

• PUT - 신규 자원 등록 특징
  • 클라이언트가 리소스 URI를 알고 있어야 한다.
    • 파일 등록 /files/{filename}
      • PUT
    • 전송형태 : PUT /files/star.jpg
  • 클라이언트가 직접 리소스의 URI를 지정한다.
  • 스토어(Store)
    • 이러한 형태의 관리를 스토어라고 불린다.
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 여기서 스토어는 /files

 

HTML FORM 사용

• HTML FORM은 GET, POST만 지원

• AJAX 같은 기술을 사용해서 해결 가능 -> 회원 API 참고

• 여기서는 순수 HTML, HTML FORM을 사용한다고 가정한다.

• 컨트롤 URI
  • HTML FORM은 GET, POST만 지원하므로 제약이 있음
  • 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
    • 최대한 리소스 개념을 가지고 HTTP 메서드 설계를 하고 그 상황에서 안될때 대체제 느낌으로 컨트롤 URI를 사용해야한다.
  • POST의 /new, /edit, /delete가 컨트롤 URI 이다.
  • HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)

• 웹 페이지 회원 관리
  • 회원 목록 /members
    • GET
  • 회원 등록 폼 /members/new
    • GET
  • 회원 등록 /members/new, /members
    • 회원 등록 폼과 URL을 맞추는 방법(/members/new), 회원 목록 URL을 사용하여 컬렉션처럼 자원을 관리하는 것 방법(/members)이 있다. 둘 중에 아무거나 하나 선택하여 사용.
      • 그러나 회원 등록 폼과 회원 등록을 URL 경로를 맞추는 방법이 좋을 수 있다. 회원 등록 요청을 했는데 벨리데이션 문제로 다시 회원 등록 요청 결과를 회원 등록 폼으로 보내야 하는 경우가 생길 수 있다. 회원 등록 폼과 회원 등록 URL이 맞추어져 있으면 경로가 안바뀌고 깔끔하게 해결할 수 있지만 URL 경로가 다른 경우 처리하기 애매해지는 경우가 있다.
    • POST
  • 회원 조회 /members/{id}
    • GET
  • 회원 수정 폼 /members/{id}/edit
    • GET
  • 회원 수정 /members/{id}/edit, /members/{id}
    • 회원 수정 폼과 URL을 맞추는 방법(/members/{id}/edit), 회원 목록 URL을 사용하여 컬렉션처럼 자원을 관리하는 것 방법(/members/{id})이 있다. 둘 중에 아무거나 하나 선택하여 사용.
    • POST
  • 회원 삭제 /members/{id}/delete
    • POST

 

HTTP API 설계 정리

• HTTP API - 컬렉션
  • POST 기반 등록
  • 서버가 리소스 URI 결정
  • 예) 회원 관리 API 제공

• HTTP API - 스토어
  • PUT 기반 등록
  • 클라이언트가 리소스 URI 결정
  • 예) 정적 컨텐츠 관리, 원격 파일 관리

• HTML FORM 사용
  • 웹 페이지 회원 관리
  • 순수 HTML + HTML form 사용
  • GET, POST만 지원

 

• URI 설계 개념
  • 문서(document)
    • 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
    • 예) /members/100, /files/star.jpg
  • 컬렉션(collection)
    • 서버가 관리하는 리소스 디렉터리
    • 서버가 리소스의 URI를 생성하고 관리
    • 예) /members
  • 스토어(store)
    • 클라이언트가 관리하는 자원 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 예) /files
  • 컨트롤러(controller), 컨트롤 URI
    • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
    • 동사를 직접 사용
    • 예) /members/{id}/delete

---

[참고자료]

모든 개발자를 위한 HTTP 웹 기본 지식, 김영한

Microsoft REST API Guidelines