모든 개발자를 위한 HTTP 웹 기본 지식 강의를 공부하고 정리한 글입니다.
회원 정보 관리 HTTP API 설계
요구사항
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
리소스 식별, URI 계층 구조 활용
- 회원 목록 조회
/members - 회원 조회
/members/{id} - 회원 등록
/members/{id} - 회원 수정
/members/{id} - 회원 삭제
/members/{id}
💡 참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)
리소스와 행위를 분리
- 가장 중요한 것은 리소스 식별이다.
- URI는 리소스만 식별해야 한다.
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리해야 한다.
- 리소스:
회원 - 행위:
조회,등록,삭제,변경
- 리소스:
- 이를 HTTP 메서드를 통해 구분한다.
HTTP 메서드 종류
주요 메서드
GET: 리소스 조회POST: 요청 데이터 처리, 주로 등록에 사용한다.PUT: 리소스를 대체하며 해당 리소스가 없으면 생성한다.PATCH: 리소스 부분 변경DELETE: 리소스 삭제
기타 메서드
HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정 (거의 사용 X)TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행 (거의 사용 X)
GET
클라이언트 → 서버 (요청)
GET /members/100 HTTP/1.1
Host: example.com- 리소스 조회를 요청한다.
- 서버에 전달하고 싶은 데이터는
query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다. - 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 이는 권장하지 않음
→ 위 예시의 JSON은 정해진 것이 아니라 HTML일 수도 있고 다양함
서버 → 클라이언트 (응답)
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 34
{
"username": "young",
"age": 20
}POST
클라이언트 → 서버 (요청)
POST /members HTTP/1.1
Content-Type: application/json
{
"username": "young",
"age": 20
}- 요청한 데이터를 처리한다.
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우에도 사용
- 메시지 바디를 통해 서버로 데이터를 전달한다.
- 서버는 요청 데이터를 처리한다.
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
서버 → 클라이언트 (응답)
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 34
Location: /members/100
{
"username": "young",
"age": 20
}GET/POST 방식
- 두 방식 모두 서버에 요청을 하는 메서드이다.
GET은 주로 웹 브라우저가 웹 서버에데이터를 요청할 때 사용한다.POST는 웹 브라우저가 웹 서버에데이터를 전달하기 위해 사용한다.
GET 방식으로 데이터를 보내기
GET방식은 URL 뒤에 “?” 마크를 통해 데이터를 key-value 쌍으로 구분하여 스트링 형태로 전달한다.- URL뒤에 붙이므로 패킷의 헤더에 포함되어 서버에 요청하는데, 바디는 빈상태로 보내진다.
- 그러므로 길이의 제한이 있어 전송 데이터의 한계가 있고 보안성이 떨어진다.
POST 방식으로 데이터를 보내기
POST방식은 GET 방식과 달리 데이터를 URL 뒤에 붙여서 보내지 않고 바디에 넣어서 보낸다.- 그러므로 헤더 필드에 바디에 존재하는 데이터를 설명해주는
Content-Type가 포함되고 이는 어떤 데이터 타입인지 명시한다. - 서버로 데이터를 보내기 전에 인코딩하고, 전송 후 서버에서는 다시 디코딩 작업을 하므로 보안성이 높다.
- 스트링 데이터 뿐만 아니라, 라이오 버튼, 텍스트 박스 같은 객체들의 값도 전송이 가능하다.
- 따라서 웹서버에 많은 데이터를 전달하기 위해서는 POST 방식을 사용하는 것이 바람직하다.
PUT
- 리소스가 없으면 새로운 리소스를 생성하고, 리소스가 있으면 리소스를 완전히 대체한다.
- 리소스를 수정하는 것이 아닌, 완전히 위에 덮어버린다는 의미이다.
- 따라서 부분 수정이 불가능하다.
- POST와 차이점
- PUT은 클라이언트가 리소스의 위치를 알고 URI를 지정한다. 이를
store라고 한다.
ex) /members/100
- POST는 클라이언트가 리소스의 위치를 알지 못하고 자동으로 만들어준다.
- PUT은 클라이언트가 리소스의 위치를 알고 URI를 지정한다. 이를
PUT /members/100 HTTP/1.1
Host: example.com
Content-type: application/json
{
"name": "minsu",
"age": 20
}PATCH
- 리소스의 부분 수정시 사용
- 아래의 경우
age만30으로 변경된다.
PATCH /members/100 HTTP/1.1
Host: example.com
Content-type: application/json
{
"age": 30
}DELETE
- 리소스 제거시 사용
DELETE /members/100 HTTP/1.1
Host: example.comHTTP 메서드의 속성
안전(Safe Methods)
- 호출해도 리소스가 변경되지 않는다.
GET→ 조회이므로 안전함POST,PUT,DELETE,PATCH→ 리소스 변경하기에 안전하지 않음
멱등(Idempotent Methods)
- f(f(x)) = f(x)
- 메서드를 반복 호출해도 결과가 똑같다.
GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.- 자동 복구 메커니즘에 활용
캐시가능(Cacheable Methods)
- 응답 결과리소스를 캐시해서 사용해도 되는가?
GET,HEAD캐시 가능POST,PATCH도 캐시 가능하나, 본문 내용까지 캐시 키로 고려하는 것이 어려우므로 구현이 쉽지 않음
Reference
Backend Developer 💻 😺