API URI 설계 & HTTP METHOD

API URI 설계 (Uniform Resource Identifier)

• 회원 목록 조회 /read-member-list

• 회원 조회 /read-member-by-id

• 회원 등록 /create-member

• 회원 수정 /update-member

• 회원삭제 /delete-member

위와 같이 설계된 API는 잘 설계가 된 것 일까? 그렇지 않다.

이유는 아래의 내용을 보자

API URI 고민

• 리소스의 의미란?
  • 회원을 등록하고 수정하고 조회하는게 리소스가 아니다
  • 예) 미네랄을 캐라 -> 미네랄이 리소스
  • 회원이라는 개념 자체가 리소스다
• 리소스를 어떻게 식별하는게 좋을까?
  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑

그럼 어떻게 설계를 해야할까? 회원이라는 리소스에 집중해서 설계해야한다.

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

그렇다면 위와 회원이라는 리소스에 집중하여 설계했을 때 조회,등록,수정,삭제는 도대체 어떻게 구분해야 할까? 이때 필요한것이 HTTP 메소드이다.

API를 설계 할때 가장 중요한것은 리소스를 식별하는것이다.

• URI는 리소스만 식별
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원
  • 행위: 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사 (미네랄을 캐라)
• 행위(메소드)는 어떻게 구분하는가? => HTTP 메소드를 통해 구분

HTTP API 설계에 대한 좋은 예시는 아래에서 설명하고 지금은 우선 HTTP METHOD에 대해 알아보자

HTTP METHOD

• GET : 리소스 조회

  서버에 전달하고 싶은 데이터는 Query Paramter, Query String을 통해서 전달

  메시지 바디를 사용해서도 데이터를 전달 할 수도 있지만, 지원하지 않는곳이 많아서 권장 되지 않음

• POST : 요청 데이터 처리, 주로 등록에 사용

  메시지 바디를 통해 서버로 요청 데이터 전달

  서버는 요청 데이터를 처리[메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다]

• PUT : 리소스를 대체, 해당 리소스가 없으면 생성

  클라이언트가 리소스 위치를 알고 URI를 지정한다 (POST와의 차이점)

• PACH : 리소스 부분 변경

• DELETE : 리소스 삭제

HTTP METHOD 속성

• 안전 (Safe Methods) -> 해당 리소스만 변하는지 안변하는지 고려한다

  • 호출해도 리소스를 변경하지 않는다.

• 멱등 (Idempotent)

  • 한 번 호출하든 몇 번을 호출하든 결과가 똑같다
  • 멱등 메서드
    • GET : 한번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
    • PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
    • DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
    • POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생 할 수 있다.
  • 활용
    • 자동 복구 메커니즘
    • 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시해도 되는가? 에대한 판단 근거가 된다.

  • 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려치 않는다.

    EX) 재요청 중간에 다른곳에서 리소스를 변경

• 캐시 가능 (Cacheable)

  • 응답 결과 리소스를 캐시해서 사용해도 되는지?
  • GET, HEAD, POST, PATCH 캐시 가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용

HTTP METHOD 활용

클라이언트에서 서버로 데이터 전송 방식

• 쿼리 파라미터를 통한 데이터전송
  • GET
  • 주로 정렬 필터(검색어)

• 메시지 바디를 통한 데이터 전송

  • POST, PUT, PATCH

    • Content-Type : application/x-www-form-urlencoded 사용

      • form의 내용을 메시지 바디를 통해서 전송 (key=value, 쿼리 파라미터 형식)

      • 전송 데이터를 url encoding 처리

        예) abc김 => abc%EA%B9%80

    • Content-Type: multipart/form-data

      • 파일 업로드 같은 바이너리 데이터 전송시 사용
      • 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능
• HTTP API 데이터 전송
  • Content-Type : application/json 주로 사용
    • TEXT, XML, JSON

HTTP API 설계

POST 기반 방식

• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /mebmers/{id} -> GET
• 회원 수정 /members/{id}/ -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

PUT 기반 방식

• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST

HTML FORM 방식

• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
• 회원 등록 /members/new or /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit or /members/{id} -> POST
• 회원 삭제 /members/{id}/delete -> POST

컨트롤 URI

• HTTP 메서드로 해결하기 애매한 경우 이 방법을 스며 동사로 된 리소스 경로를 사용한다
• 예시 ) POST의 /new, /edit, /delete가 컨트롤 URI

컬렉션 (Collection)

• 서버가 관리하는 리소스 디렉터리

• 서버가 리소스의 URI를 생성하고 관리

스토어 (Store)

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