HTTP 웹 기본 지식- HTTP API 설계 예시

고을마을 2022. 8. 7. 14:35

정적 데이터 조회

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

동적 데이터 조회

- 주로 검색, 게시판 목록에 정렬 필터(검색어)

- 조회는 GET 사용

- GET은 쿼리 파라미터 사용해서 데이터 전달(ex: https://www.google.com/search?q=hello&hl=ko)

HTML Form 데이터 전송

- HTML Form Submit시 POST 전송 (ex: 회원가입, 상품주문, 데이터 변경)

- Content-Type : application/x-www-form-urlencoded 사용

: form의 내용을 메시지 바디를 통해서 전송(key=value)

: 전송된 데이터를 url encoding 처리. (abc 김 → abc%EA%B9%80)

- HTML Form은 GET 전송도 가능.

- Content-Type : multipart/form-data

: 파일 업로드 같은 바이너리 데이터 전송시 사용

: 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능

- HTML Form 전송은 GET, POST만 지원

HTTP API 데이터 전송

-웹 클라이언트

: HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX)

- POST, PUT, PATCH : 메시지 바디를 통해 데이터 전송

- GET: 조회, 쿼리 파라미터로 데이터 전달

- Content-Type : application/json을 주로 사용

- 클라이언트는 등록될 리소스의 URI를 모른다!

: 회원등록 / members → POST

- 서버가 새로 등록된 리소스 URI를 생성해준다. (ex: /members/100)

- 컬렉션(Collection)

: 서버가 관리하는 리소스 디렉토리

: 서버가 리소스의 URI를 생성하고 관리

: 여기서 컬렉션은 /members

- 클라이언트가 리소스의 URI를 알고 있어야 한다!

: 파일등록 /files/{filename} → PUT

- 클라이언트가 직접 리소스의 URI를 지정한다.

- 스토어(Store)

: 클라이언트가 관리하는 리소스 저장소

: 클라이언트가 리소스의 URI를 알고 관리

: 여기서 스토어는 /files

- HTML FORM은 GET, POST만 지원

- 컨트롤 URI

: GET, POST만 지원하므로 제약이 있음.

: 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용

: POST의 /new, /edit, /delete가 컨트롤 URI

: HTTP 메서드로 해결하기 어려운 경우 사용