[모든 개발자를 위한 HTTP 웹 기본 지식] 5. HTTP 메서드 활용

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

데이터 전달 방식(크게 2가지)

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

 

클라이언트에서 서버로 데이터를 전송하는 4가지 상황

1. 정적 데이터 조회
2. 동적 데이터 조회
3. HTML Form을 통한 데이터 전송
   • 회원 강비, 상품 주문, 데이터 변경
4. HTTP API를 통한 데이터 전송
   • 회원 가입, 상품 주문, 데이터 변경
   • 서버 to 서버, 앱 클라이언트, 웹 클라이언트(Ajax)

 

1. 정적 데이터 조회

• 이미지, 정적 텍스트 문서
• 조회는 GET 사용
• 쿼리 파라미터 미사용
  • 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회 가능

 

2. 동적 데이터 조회

• 조회는 GET 사용
• 쿼리 파라미터 사용
  • 쿼리 파라미터를 기반으로 정렬 필터해서 결과를 동적으로 생성함
  • 주로 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에서 사용 (ex.검색, 게시판 목록)
• GET은 쿼리 파라미터 사용해서 데이터를 전달

 

3. HTML Form 데이터 전송

POST 전송 - 저장

• form태그의 props에 method=”post”로 입력 폼에 입력 데이터 전달

<form action="/save" method="post">
	<input type="text" name="username"/>
	<input type="text" name="age"/>
	<button type="submit">전송</button>
</form>

• 웹 브라우저가 생성한 요청 HTTP 메시지: 데이터가 body에 담겨서 서버로 전송됨

POST /save HTTP/1.1
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded

username=kim&age=20

GET 전송 - 저장

• method=”get”으로 입력 폼에 입력한 데이터 전달 (쿼리로 보냄)

<form action="/save" method="get">
	<input type="text" name="username"/>
	<input type="text" name="age"/>
	<button type="submit">전송</button>
</form>

• 웹 브라우저가 생성한 요청 HTTP 메시지: 데이터가 쿼리로 서버로 전송됨
  • [주의!] GET은 조회에만 사용해야만 하지, 이렇게 리소스를 변경이 발생하는 곳에서 사용하면 안됨. 그냥 form에서 method에 따라 달라짐을 확인하기 위해 본 것!

GET /save?username=kim&age=20 HTTP/1.1
Host: localhost:8080

multipart/form-data

• form에서 파일을 보내는 경우
  • byte로 구성
• 앞선 POST의 Content-Type이 “application/x-www-form-urlencoded”이 하는 역할
  • username: ”이름” 이렇게 한글로 들어가게 되어도 인코딩되어서 잘 전달됨 (% 포함된 뭐 그런 형식으로)
• request

<form action="/save" method="post" enctype="multipart/form-data">
	<input type="text" name="username"/>
	<input type="text" name="age"/>
	<input type="file" name="file1"/>
	<button type="submit">전송</button>
</form>

• 웹 브라우저가 생성한 요청 HTTP 메시지
  • 메시지를 boundary(경계) 단위로 자름
  • form-data의 역할
    • 여러 컨텐츠에 대한 타입 데이터들을 보낼 수 있음
    • 주로 binary 데이터를 전송할 때 사용

POST /save HTTP/1.1
Host: localhost:8080
Content-Type: multipart/form-data; boundary=---XXX
Content-Length:10457

------XXX
Content-Disposition: form-data; name="username"

kim
------XXX
Content-Disposition: form-data; name="age"

20
------XXX
Content-Disposition: form-data; name="file1"; filename="intro.png"
Content-Type: image/png

012093980jisdfo1j4u8uupio13jkl431jkl413439090f...
------XXX--

 

🍒 Recap

• HTML Form submit시 POST 전송함
• Content-Type: application/x-www-form-urlencoded 사용
  • form의 내용은 메시지 바디를 통해 전송(key=value, 쿼리 파라미터 형식)
  • 전송 데이터를 url encoding 처리함
• HTML Form은 GET 전송도 가능은 함(쿼리 파라미터로 들어가게 됨)
• Content-Type: multipart/form-data
  • 파일 업로드 같이 binary data 전송 시 사용
  • 다른 종류의 여러 파일과 폼의 내용을 함께 전송할 수 있음. 그래서 이름이 multipart인 것
• 참고로, HTML Form 전송은 GET, POST 메서드만 지원함

 

4. HTML API 데이터 전송

• 서버 to 서버
  • 백엔드 시스템 통신
  • HTML 같은거 없이 기계끼리만 통신하는거기 때문
• 앱 클라이언트
  • 아이폰, 안드로이드
• 웹 클라이언트
  • HTML에서 Form 전송 대신 자바스크립트를 통한 통신에 사용(Ajax)
  • ex. React, Vue와 같은 웹 클라이언트와 API 통신
• 메서드
  • GET: 조회, 쿼리 파라미터로 데이터 전달
  • POST, PUT, PATCH: 메시지 바디를 통해 데이터 전송
• Content-Type: application/json을 주로 사용 (사실상 표준임)
  • Text, XML, JSON 등
  • 옛날에는 XML이지만, 최근에는 대부분 JSON (심플하고 데이터 크기가 상대적으로 작기 때문)

 

 

HTTP API 설계 예시

• HTTP API 컬렉션
  • POST 기반 등록
  • ex. /members와 같은 것
• HTTP API - 스토어
  • PUT 기반 등록
  • POST vs PUT 정리 필수
• HTML Form 사용
  • GET, POST만 지원

 

1. API 설계 - POST 기반 등록 (회원 관리 시스템)

• 회원 목록 /members → GET
• 회원 등록 /members/ → POST
• 회원 조회 /members/{id} → GET
• 회원 수정 /members/{id} → PATCH, PUT, POST
  • PATCH로 하는게 젤 좋긴 함
  • 왜냐면 대부분 회원 정보를 수정할 때 회원 정보를 전부다 보내지 않고 일부만 변경하기 때문
  • PUT 사용의 예로, 게시판 글 수정하는 경우 (일부를 변경하지 않음)
  • 만약 PATCH도 PUT도 애매하다? 그럴 때 POST 사용
• 회원 삭제 /members/{id} → DELETE

POST - 특징

• 클라이언트는 등록될 리소스의 URI를 모름
  • 정확한 URI의 주소를 몰라도 됨
  • 회원 등록: POST /members
  • 이것이 PUT과 다른 점임
• 서버가 새로 등록된 리소스 URI를 생성해줌
  • HTTP/1.1 201 Created Location: /members/100
• 컬렉션(Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 위와 같은 방식이 바로 컬렉션이라고 함
  • 여기서 컬렉션은 /members임

 

2. API 설계 - PUT 기반 등록 (파일 관리 시스템)

• 파일 목록 /files → GET
• 파일 조회 /files/{filename} → GET
• 파일 등록 /files/{filename} → PUT
  • 왜냐하면 사용자가 등록할 파일명을 알고있기 때문
• 파일 삭제 /files/{filename} → DELETE
• 파일 대량 등록 /files → POST

PUT - 신규 자원 등록 특징

• 클라이언트가 리소스 URI를 알고 있음 (클라이언트가 직접 생성될 리소스의 URI를 지정함)
  • 파일 등록: PUT /files/{filename}
• 스토어(Store)
  • 이런 방식의 관리 시스템을 스토어라고 함
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 여기서 스토어는 /files임

그럼 1(POST) 2(PUT) 둘 중, 어느 방식이 더 많이 쓰이냐?
→ 실무에서는 대부분 POST(컬렉션)을 사용

 

3. HTML FORM 사용

• HTML FORM은 GET, POST만 지원 (제약이 있음)
• Ajax와 같은 기술을 사용해서 해결 가능하긴 함
• 여기서는 순수 HTML, HTML FORM에 대한 이야기임

API 설계

• 회원 목록 /members → GET
• 회원 등록 폼 /members/new → GET
• 회원 등록 /members/new, /members → POST
  • /new 붙이는게 더 나음. 경로가 안바뀌어서 refresh 안하고 깔끔하기 때문
• 회원 조회 /members/{id} → GET
• 회원 수정 폼 /members/{id}/edit → GET
• 회원 수정 /members/{id}/edit, /members/{id} → POST
• 회원 삭제 /members/{id}/delete → POST(DELETE 못쓰기 때문에 컨트롤 URI 사용함)

⭐️ 컨트롤 URI
- HTMl FORM이 GET, POST만 지원하는 제약을 해결하기 위해 사용
- 동사로 된 리소스 경로를 사용함
- POST의 /new, /edit, /delete가 컨트롤 URI의 예시임
- HTTP 메서드로 해결하기 애매한 경우에 사용함(HTTP API 포함) → 실무에서는 정말 많이 씀! 왜냐하면 애매한 경우가 정말 많기 때문..ㅠㅠ 근데 메서드를 다 써보고나서 마지막 대안으로만 써야함

 

 

🍒 HTTP API 설계 - Recap

• HTTP API - 컬렉션
  • POST 기반 등록
  • 서버가 리소스 URI 결정
• HTTP API - 스토어
  • PUT 기반 등록
  • 클라이언트가 리소스 URI 결정
• HTML FORM 사용
  • 순수 HTML + HTML Form 사용
  • GET, POST만 지원

 

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

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