liamchoi943 / http

0 stars 0 forks source link

http api를 만들어보자 #9

Open liamchoi943 opened 3 years ago

liamchoi943 commented 3 years ago

http 메서드- get, post, put, patch, delete

api를 만드는대 요구사항: 회원 목록 조회 회원 조회 회원 등록 회원 수정 회원 삭제

API URI 설계: << 이게 과연 좋은 설계인가? 회원 목록 조회 / read-member-list 회원 조회 / read-member-by-id 회원 등록 / create-member 회원 수정 /update-member 회원 삭제 /delete-member

가장 중요한 것은 리소스 식별!!! 리소스의 의미는? 회원을 등록하고 수정하고 조회하는게 리소스가 아니다 예) 미네랄을 캐라 -> 미네랄 리소스 회원이라는 개념 자체가 바로 리소스다 리소스를 어떻게 식별함? 회원을 등로하고 수정하고 조회하는 것을 모두 배제 회원이라는 리소스만 식별하면 됨! -> 회원 리소스를 URI에 매핑

이런경우에는 리소스 (회원을 식별하고) URI 계층 구조를 활용하면된다 회원 목록 조회/members 회원 조회/members/{id} 회원 등록 /members/{id} 회원 수정 /members/{id} 회원 삭제/ members/{id}

참고*** 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 (not member, but members)

그러면... 회원 조회/members/{id} 회원 등록 /members/{id} 회원 수정 /members/{id} 회원 삭제/ members/{id} >> 이놈들을 어케 구분함?

URI는 리소스만 식별! 리소스와 해당 리소스를 대상으로 하는 행위를 분리 리소스: 회원 행위: 조회, 등록, 삭제, 변경 리소스는 명사, 행위는 동사라고 생각하면됨 행위(메서드)는 어떻게 구분?

HTTP 주요 메서드 get: 리소스 조회 post: 요청 데이터 처리, 주로 등록에 사용 put: 리스소를 대체, 해당 리소스가 없으면 생성 patch: 리소스 부분 변경 delete: 리소스 삭제

기타 메서드 head: get와 동일하지만 메세지 부분을 제외하고, 상태 줄과 헤더만 반환 options: 대상 리소스에 대한 통신 기능 옵션(메서드)을 설명 (주로 CORS에서 사용) connect: 대상 자원으로 식별되는 서버에 대한 터널을 설정 trace: 대상 리소스에 대한 경로를 따라 메세지 루트백 테스트를 수행

GET

  1. 리소스 조회
  2. 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)을 통해서 전달
  3. 메세지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음.

POST

  1. 요청 데이터 처리
  2. 메세지 바디를 통해 서버로 요청 데이터 전달
  3. 서버는 요청 데이터를 처리. 메세지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행함
  4. 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

post는 요청 데이터를 어떻게 처리한다는 뜻일까? post 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청함 예를 들어 post는:

  1. html양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
  2. 게시판 뉴스 그룹 메일링 리스트 블로그 또한 유사한 기사 그룹에 메세지 게시
  3. 서버가 아직 식별하지 않은 새 리소스 생성
  4. 기존 자원에 데이터 추가 정리: 이 리소스 URI에 POST요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함