HTTP 메서드 활용
- 클라이언트에서 서버로 데이터 전송
- HTTP API설계 예시
클라이언트에서 서버로 데이터 전송 2가지 방식
- 데이터를 전달 하는 크게 2가지 방식
- 쿼리 파라미터를 통한 데이터 전송
- 메세지 바디를 통한 데이터 전송
- POST, PUT, PATCH
- 회원가입, 상품주문, 리소스 등록, 리소스 변경
클라이언트에서 서버로 데이터 전송 4가지 상황
-
정적 데이터 조회
-
동적 데이터 조회
- 주로 검색, 게시판 목록에서 정렬 필터 (검색어)
-
HTML Form을 통한 데이터 전송
-
HTTP API를 통한 데이터 전송
- 회원 가입, 상품주문, 데이터 변경
- 서버 to 서버, 앱 클라이언트, 웹 클라이언트(Ajax)
1.정적 데이터 조회 (쿼리 파라미터 사용)
-
클라이언트 -> 서버 : GET
클라이언트
GET /static/star.jpg HTTP/1.1
Host:localhost:8080
- 서버 -> 클라이언트
/static/star.jpg
HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Lenght:34012
~~
정리
-
이미지, 정적 텍스트 문서
-
조회는 GET사용
-
정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회 가능
2.동적 데이터 조회 (쿼리 파라미터 사용)
정리
-
주로 검색, 게시판 목록에서 정렬 필터 (검색어)
-
조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
-
조회는 GET 사용
-
GET은 쿼리 파라미터를 사용해서 데이터를 클라이언트에서 서버로 전달한다.
3.HTML Form 데이터 전송 (POST 전송 - 저장)
정리
-
HTML Form submit 시 POST 전송
-
Content-Type: application/x-www-form-urlencoded 사용
- form 의 내용응ㄹ 메세지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)
- 전송 데이터를 url encoding 처리
-
HTML Form 은 GET 전송도 가능
-
Content-Type: multipart/form-data
- 파일 업로드 같은 바이너리 데이터 전송시 사용
- 다른 종류의 여러 파일과 폼의 내용 함께 전송가능 (그래서 이름이 multipart)
-
참고: HTML Form 전송은 GET, POST만 지원 (PUT ,DELETE는 안 됨.)
HTTP API 데이터 전송
-
클라이언트 -> 서버
POST /members HTTP/1.1
Content-Type:application/json
{
"username": "junyopar",
"age":20
}
정리
- 서버 to 서버
- 앱 클라이언트
- 웹 클라이언트
- HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용 (AJAX)
- 예) React, VueJs 같은 웹 클라이언트와 API통신
- POST, PUT, PATCH: 메세지 바디를 통해 데이터 전송
- GET: 조회, 쿼리 파라미터로 데이터 전달
- Content-Type: application/json을 주로 사용 (사실상 표준)
- TEXT, XML,JSON 등등 (옛날에는 XML 사용 했었다 ~ 지금은 JSON 이 표준~ )
HTTP API 설계 예시
- HTTP API - 컬렉션
- HTTP API - 스토어
- HTML FORM 사용
회원 관리 시스템 (API 설계 -POST기반 등록 )
- 회원 목록 /members -> GET
- 회원 등록 /members -> POST
- 회원 조회 /members/{id} -> GET
- 회원 수정 /members/{id} -> PATCH, PUT, POST
- 회원 삭제 /members/{id} -> DELETE
회원관리 시스템 (POST - 신규 자원 등록 특징)
- 클라이언트는 등록될 리소스의 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
- POST로 신규 데이터를 등록 한다는것은 클라이언트는 서버에 요청하는것. 그럼 서버가 리소스 URI를 알아서 만들어서 준다.
- 근데 PUT 은 클라이언트가 알고 등록 한다. 그럼 서버는 오는 데로 해준다. : 이런 스타일의 관리를 Store라 한다.
- HTML FORM 은 GET, POST만 지원
- AJAX 같은 기술을 사용해서 해결 가능 -> 회원 API참고
- 여기서는 순수 HTML, HTML FORM 이야기
- GET, POST만 지원하므로 제약 이 있음
- 회원 목록 /members -> GET
- 회원 등록록 폼 /members/new -> POST
- 회원 등록 /members/new, /members (두가기중 아무나 근데 전자를 선호함) -> POST
- 회원 조회 /members/{id} -> GET
- 회원 수정 폼 /members/{id}/edit -> GET
- 회원 수정 /members/{id}/edit, /members/{id} -> POST
- 회원 삭제 /members/{id}/delete -> POST
- HTML FORM 은 GET, POST만 지원 하기 때문에
- 컨트롤 URI 를 사용해야한다.
- 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
- POST 의 /new, /edit. /delete 가 컨트롤 URI
- HTTP 메소드로 해결하기 애매한 경우 (HTTP API 포함)
컨트롤 URI를 무식하게 막 사용 하면 안 된다. 최대한 리소스 라는 개념으로 URI하고 도저히 안 될때 사용해라.
정리
- HTTP API - 컬렉션
- HTTP API - 스토어
- HTML FORM 사용
- 순수 HTML + HTML FORM 사용
- GET, POST만 지원
참고하면 좋은 URI 설계
https://restfulapi.net/resource-naming
- 문서(document)
- 단일 개념 (파일 하나, 객체 인스턴스, 데이터 베이스 row)
- 예) /members/100 , /files/star.jpg
- 컬렉션 (collection)
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스 URI를 생성하고 관리
- 스토어
- 클라이언트가 관리하는 자원 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 컨츠롤러 , 컨트롤 URI
- 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스를 실행할때
- 동사를 직접 사용
- 리소스로 무조건 설계를 해라 회원이면 /members , 주문이면 /orders
- 하다가 안 되면 컨트롤 URI로~