August 17, 2013

Designing REST API

REST API는 RPC(Remote Procedure Call) API와 다르게 기본적으로 절차적인 명령 호출의 목록으로 설계하는 것이 아니라고 생각된다. REST(Representational State Transfer) API는 선언적인 방법으로 리소스(Resource)의 표현되는 상태를 변화(GET,POST,PUT,PATCH,DELETE…)시키는 인터페이스라고 할수 있다. 그리고 이러한 리소스의 상태에 따라 시스템이 동작하는 구조라고 생각한다.(직접 시스템의 동작을 명령하는 인터페이스를 가진 것이 아닌.) REST API을 설계할때, RPC API 설계개념을 가져와 작성하게 되면 HTTP Methods(GET,POST,PUT…)으로 동작으로 명령을 정의하게 되어서 표현제약이 발생하고,결국 리소스을 가져다가 특정 동작을 정의하게 된다. 책 “일관성 있는 웹 서비스 인터페이스 설계를 위한 REST API 디자인 규칙”에서는 리소스 프로토타입에서 컨트롤러라는 이름으로 이러한 절차적인 호출을 위한 프로토타입이 있기는 하다. Read more

February 10, 2013

REST API 디자인 룰 북

REST API을 만드는 일이 많아졌다. REST API가 이미 널리 알려진 개념이지만,RESTful하다고 할수 있는 API은 어느정도는 주관적인 요소가 개입되는 것 같다. 이번에 설계를 하면서, Twitter나 Facebook의 API을 참고하긴 했지만, 각각의 스타일의 차이를 알수는 있어도 좋은 디자인 규칙에 대한 정보를 얻기가 힘들었다. 특히 리소스 모델링 부분이 어려운데, REST API Design Rulebook을 참고하여 구성하고 있다. Resource의 프로토타입을 제시 REST API Design Rulebook에서는 리소스의 원형을 다음과 같이 제시한다. 도큐먼트 컬렉션 스토어 컨트롤러 이중에서 가장 흥미로운 리소스 원형은 컨트롤러 리소스와 스토어 리소스이다. Read more

© 2019. All rights reserved.

Powered by Hugo & Kiss.