YOUNGMINKIM

2 분 소요

✔ HTTP API 설계

POST, PUT 둘 다 데이터를 등록할 때 사용이 되는데, 차이점은?

  • HTTP API - 컬렉션
    • POST 기반 등록
    • ex) 회원 관리용 API를 제공해야 하는 상황
  • HTTP API - 스토어
    • PUT 기반 등록
    • ex) 정적 컨텐츠 관리, 원격 파일 관리
  • HTML FORM 사용
    • 웹 페이지 회원 관리
    • GET, POST만 지원

회원 관리 시스템

API 설계 - POST 기반 등록

URI는 리소스만 식별해야 한다, 행위는 HTTP 메서드로 구분

  • 회원 목록 /members → GET
  • 회원 등록 /members → POST
    • ex) /members/createMember
    • ex) /members/insertMember
    • ex) /members/join
  • 단일 회원 조회 /members/{id}
    • GET
  • 단일 회원 수정 /members/{id}
    • PATCH, PUT, POST
    • 회원 데이터 수정 시 PATCH 사용 권장
    • 애매하면 POST 사용
  • 회원 삭제 /members/{id}
    • DELETE

POST - 신규 자원 등록 특징

POST의 경우 클라이언트가 리소스의 경로를 모르고, 서버에 요청을 하면 서버에서
해당 요청에 대한 결과를 만들어 반환 해준다, 이에 반해 PUT은 클라이언트가
리소스의 정보를 알고 있으며 서버에 요청을 보내는 역할

  • 클라이언트는 등록될 URI를 모른다
    • 회원 등록 /members → POST
    • POST /members
  • 서버가 새로 등록된 리소스 URI 생성
    • HTTP/1.1 201 Created Location: /members/100
  • 컬렉션(Collection)
    • 서버가 관리하는 리소스 디렉토리
    • 서버가 리소스의 URI 생성 및 관리
    • 여기서 컬렉션은 /members

파일 관리 시스템

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 이야기
  • GET, POST만 지원하므로 제약이 있음
  • 회원 목록 /members → GET
  • 회원 등록 폼 /members/new → GET (가입 화면)
  • 회원 등록 /members/new, /members → POST
  • 1:1 URI 맵핑을 하는 것을 권장, Method=”{POST, GET}”
//회원가입 폼 출력
@RequestMapping(value = "/members", method = RequestMethod.GET)
public String showMemberForm(@RequestParam ....) { }

//회원가입
@RequestMapping(value = "/members", method = RequestMethod.POST)
public String showMemberForm(@RequestParam ....) { }
  • 단일 회원 조회 /members/{id}
    • GET
  • 회원 수정 폼 /members/{id}/edit
    • GET
  • 회원 수정 /members/{id}/edit, /members/{id}
    • POST
  • 회원 삭제 /members/{id}/delete
    • POST

HTML FORM 제약

  • GET, POST만 지원
  • 컨트롤 URI
    • GET, POST만 지원 해 제약 있음
    • POST의 /new, /edit, /delete가 컨트롤 URI
    • HTTP 메서드로 해결하기 애매한 경우, 동사 리소스 경로 사용(HTTP API 포함)

참고 자료

댓글남기기

참고