HTTP API 설계 예시

 

📒 HTTP API - 컬렉션

📌 POST 기반 등록

📝예) 회원 관리 API 제공

• 회원 목록 /members -> GET 

• 회원 등록 /members -> POST 

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

• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

 

*주의! 회원 수정시 PUT은 회원 정보를 하나도 빠짐없이 전부 다 전송해야 하므로 PATCH!!

* 단, 게시글 수정의 경우는 다름. 게시글은 부분 수정이 아니라 게시글 전체를 클라이언트가 다시 서버에 보내니까 PUT!

 

이것저것 그냥 다 애매하면 POST 쓰셈

 

📝 POST - 신규 자원 등록 특징

1. 클라이언트가 "username": "hello", "age": 22 라는 정보로 POST 요청을 보냄. (이때 클라이언트는 등록될 리소스의 URI를 모름.)

2. 서버가 새로 등록된 리소스 URI를 생성해줌. 서버가 알아서 만들어서 서버가 관리하고 서버가 판단해!

->

📝 컬렉션(Collection): 서버가 관리하는 리소스 디렉토리. 위의 파일 관리 시스템의 예시에서 스토어는 /members

 

 

📒 HTTP API - 스토어

📌 PUT 기반 등록

📝예) 파일 관리 시스템

• 파일 목록 /files -> GET 

• 파일 조회 /files/{filename} -> GET 

• 파일 등록 /files/{filename} -> PUT 

• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST (*등록할 때 PUT을 사용하므로 POST는 임의의로 지정)

 

📝 PUT- 신규 자원 등록 특징

1. 클라이언트가 리소스 URI를 알고 있고 직접 지정함.

즉, 파일을 등록할 때 {filename}을 넣어줘야 함. 예를 들어 PUT/files/star.jpg

클라이언트가 직접 지정해서 클라이언트가 알아서 관리해!

->

📝 스토어 (Store): 클라이언트가 관리하는 리소스 저장소. 위의 파일 관리 시스템의 예시에서 스토어는 /files

 

일반적으로 POST 기반 등록 방식이 쓰임.

 

 

📒 HTTP FORM 사용

📌웹 페이지 회원 관리 

📝GET, POST만 지원

물론 AJAX 등을 사용해서 해결 가능하지만 순수 HTML FORM만 사용해서 GET, POST만 사용가능하다면?

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

 

* 회원 등록(수정) 폼과 회원 등록(수정) URI를 맞춰주는 것이 좋은듯 아마..? 사람마다 스타일이 다르다고 하긴 하지만.

 

📝 컨트롤 URI(컨트롤러)

* 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행

* GET, POST만으로는 제약이 있을 수 있음. 이 경우 어쩔 수 없이 동사로 된 리소스 경로 사용해야 함.

* POST의 /new, /edit, /delete 등등.

* 실무에서는 이상적인 부분과 다름. 애매한 부분이 많아서 많이 사용된다고 함. 그렇지만 어디까지나 대체제일 뿐~!

 

📝URI 네이밍 참고 링크

https://restfulapi.net/resource-naming