HTTP 웹 기본 지식(HTTP API 설계)

과부하가즈아 2023. 7. 24. 21:56

HTTP API 설계

🔴HTTP API - 컬렉션

🔴HTTP API - 스토어

🔴HTML FORM 사용

POST 기반으로의 데이터 등록

회원 목록 /members -> GET
회원 등록 /members -> POST
회원 조회 /members/{id} -> GET
회원 수정 /members/{id} -> PATCH(부분 수정시 용이_주로 사용), PUT(전체 내용을 수정시 용이), POST(PATCH, PUT 모두의 사용이 애매할 때)
회원 삭제 /members/{id} -> DELETE

클라이언트는 등록될 리소스의 URI를 모른다.
- 회원 등록 /members -> POST
- POST /members ------

등록 데이터를 보낸뒤 보낸 데이터의 고유 값을 모른다는 의미이다.

즉, A와 B의 정보에 C라는 정보를 등록한다는 POST를 보냈을 때 C의 정보가 어떤 주소값으로 들어갔는지 모른다.

서버가 새로 등록된 리소스 URI를 생성해준다.

서버가 알아서 C라는 정보를 저장하고 그 주소 값을 생성해준다. ex.100

HTTP/1.1 201 Created
Location: /members/100

이러한 형식을 컬렉션(Collection)이라고 한다.
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members

PUT 기반으로의 데이터 등록

파일 목록 /files -> GET
파일 조회 /files/{filename} -> GET
파일 등록 /files/{filename} -> PUT _ 같은 이름의 file가 있다면 덮어버리고 새로 등록!
파일 삭제 /files/{filename} -> DELETE
파일 대량 등록 /files -> POST_다른 경로 즉, 대량의 파일 등록이 아닌 경로로 설정해도 됨

클라이언트가 리소스 URI를 알고 있어야 한다.
- 파일 등록 /files/{filename} -> PUT
- PUT /files/star.jpg
클라이언트가 직접 리소스의 URI를 지정한다.
스토어(Store)
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files

주로 POST를 사용해서 신규 데이터를 등록! PUT의 비중은 아주 저조하다!

HTML FORM 사용으로의 데이터 등록

HTML FORM은 GET, POST만 지원
- AJAX 같은 기술을 사용해서 해결 가능

다만, 순수 HTML, HTML FORM을 사용한다고 하면 GET, POST만 지원하므로 제약이 있다.

회원 목록 /members -> GET

-맞춰 주냐
회원 등록 폼 /members/new -> GET
회원 등록 /members/new -> POST
-다르게 하냐
회원등록 폼 /members/new -> GET
회원등록 /members/members -> POST

회원 조회 /members/{id} -> GET

-맞춰 주냐
회원 수정 폼 /members/{id}/edit -> GET
회원 수정 /members/{id}/edit -> POST
-다르게 하냐
회원수정폼 /members/{id}/edit -> GET
회원수정 /members/{id} -> POST

회원 삭제 /members/{id}/delete_컨트롤URI -> POST

컨트롤 URI
- GET, POST만 지원하므로 제약이 있음
- 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
- POST의 /new, /edit, /delete가 컨트롤 URI_리소스라는 개념을 가지고 URI를 가지고 설계를 하고 정 안될때 사용할 것
- HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)

💫참고하면 좋은 URI 설계 개념

문서(document)
단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
예) /members/100, /files/star.jpg

컬렉션(collection)
서버가 관리하는 리소스 디렉터리
서버가 리소스의 URI를 생성하고 관리
예) /members

스토어(store)
클라이언트가 관리하는 자원 저장소
클라이언트가 리소스의 URI를 알고 관리
예) /files

컨트롤러(controller), 컨트롤 URI
문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
동사를 직접 사용
예) /members/{id}/delete

URI 설계 참고 자료: REST API - URL Naming Conventions (restfulapi.net)

인프런 : 모든 개발자를 위한 HTTP 웹 기본 지식 강의 수강 후 작성