HTTP 메서드 활용

1. 클라이언트에서 서버로 데이터 전송

 

1) 데이터 전달 방식

• 쿼리 파라미터를 통한 데이터 전송
  • GET
  • 주로 정렬 필터(검색어)
• 메시지 바디를 통한 데이터 전송
  • POST, PUT, PATCH
  • 회원가입, 상품 주문, 리소스 등록, 리소스 변경

 

2) 4가지 상황

• 정적 데이터 조회 - 쿼리 파라미터 미사용 / GET
  • 이미지, 정적 텍스트 문서
• 동적 데이터 조회 - 쿼리 파라미터 사용 / GET
  • 주로 검색, 게시판 목록에서 정렬 필터(검색어)
• HTML Form을 통한 데이터 전송 
  • 회원 가입, 상품 주문, 데이터 변경
  • POST
    • Content-Type: application/x-www-form-urlencoded 사용
      • form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)
      • 전송 데이터를 url encoding 처리
  • GET(GET은 조회에만 사용! 리소스 변경이 발생하는 곳에 사용하면 안됨)
  • multipart/form-data : 파일 업로드 등 바이너리 데이터 전송시 사용
  • HTML Form 전송은 GET, POST 만 지원
• HTTP API를 통한 데이터 전송
  • 회원 가입, 상품 주문, 데이터 변경
  • 서버 to 서버
    • 백엔드 시스템 통신
  • 앱 클라이언트
    • 아이폰, 안드로이드
  • 웹 클라이언트 (Ajax)
    • HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX)
  • POST, PUT, PATCH : 메시지 바디를 통해 데이터 전송
  • GET : 조회, 쿼리 파라미터로 데이터 전달
  • Content-Type:application/json 을 주로 사용(사실상 표준)
    • TEXT, XML, JSON 등등

---

2. HTTP API 설계 예시

 

1) 회원 관리 시스템
api 설계 - post 기반 등록

• 회원 목록 /members ▶︎ GET
• 회원 등록 /members ▶︎ POST
• 회원 조회 /members/{id} ▶︎ GET
• 회원 수정 /members/{id}
  ▶︎ PATCH, PUT(기존 것을 삭제하고 덮어버리는 것, 잘 안씀, 게시판의 게시글을 수정할 때는 ㄱㅊ), POST
• 회원 삭제 /members/{id} ▶︎ DELETE

 

2) POST - 신규 자원 등록 특징

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

 

3) 파일관리시스템
api 설계 - put 기반 등록

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

 

4) PUT - 신규 자원 등록 특징

• 클라이언트가 리소스 URI를 알고 있어야 한다.
  • 파일 등록 /files/{filename} ▶︎ PUT
  • PUT /files/star.jpg
• 클라이언트가 직접 리소스의 URI를 지정한다.
• 스토어(store)
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 여기서 스토어는 /files

 

5)  POST - 신규 자원 등록 특징

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

 

6) HTML FORM 사용

• HTML FORM은 GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능 ▶︎ 회원 API 참고
• GET, POST만 지원
• 컨트롤 URI
  • GET, POST만 지원하는 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • /new, /edit, /delete
• 회원 목록 /members ▶︎ GET
• 회원 등록 폼 /members/new ▶︎ GET
• 회원 등록 /members/new, /members ▶︎ POST
• 회원 조회 /members/{id} ▶︎ GET
• 회원 수정 폼 /members/{id}/edit ▶︎ GET
• 회원 수정 /members/{id}/edit, /members/{id} ▶︎ POST
• 회원 삭제 /members/{id}/delete ▶︎ POST

 

7) 참고하면 좋은 URI 설계 개념

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

https://restfulapi.net/resource-naming