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

본 문서는 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 보고 제 주관대로 정리한 글입니다.

---

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

정적 데이터 조회

• GET 사용
• 이미지, 정적 텍스트 문서 등

동적 데이터 조회

• GET 사용
• 검색, 게시판 목록에서 정렬 또는 필터에 주로 사용
• 쿼리 파라미터로 데이터 전달

HTML Form 데이터 전송

POST 전송

• Content-Type: application/x-www-form-urlencoded 사용
• Form의 데이터를 메시지 바디로 전송(key=value 형식)
• 전송 데이터는 url encoding 처리

GET 전송

• GET으로 요청하면 쿼리 파라미터로 데이터가 전송
• 리소스 변경에는 사용하면 안 되고, 조회에만 사용!

Content-Type: multipart/form-data

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

109238a9o0p3eqwokjasd09ou3oirjwoe9u34ouief...
------XXX--

• 파일 같은 바이너리 데이터 전송시 사용
• 여러 종류의 데이터를 함께 전송 가능 - 그래서 이름이 multipart

HTTP API 데이터 전송

• 서버 to 서버, 웹/앱 클라이언트 등에서 사용
• GET은 조회, 쿼리 파라미터로 데이터 전송
• POST, PUT, PATCH는 메시지 바디로 데이터 전송
• Content-Type: application/json - JSON을 사용하는 게 사실상 표준

HTTP API 설계 예시

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

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

특징

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

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

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

특징

• 클라이언트가 리소스의 URI를 알고 있어야 한다.
  • 파일 등록 PUT /files/{filename}
• 스토어(Store)
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리

HTML FORM 사용 설계

• 회원 목록 /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

특징

• GET, POST만 지원하기 때문에 제약이 있음
• 컨트롤 URI
  • 제약을 피하기 위해 동사로 된 리소스 경로 사용
  • POST /new, /edit/ delete가 컨트롤 URI
  • 일반적인 API에서도 메서드로 해결하기 어려운 경우 사용

URI 설계시 참고하기 좋은 사이트

https://restfulapi.net/resource-naming/