Restful API 잘 정의하기

RESTful API Design, Second Edition

by Apigee

http://www.slideshare.net/apigee/restful-api-design-second-edition

RESTful API란 기본적으로 데이타를 생성,읽기,수정,삭제 하는 작업이다. 

이 작업들을 간단하게 CRUD(Create, Read, Update, Delete)라고 한다.

DB SQL 작업도 CRUD의 범주에 있다.

RESTful API 란  HTTP를 통하여 웹서버 및 Database 로 구성된 서버에게 데이타 operation을 요청하고, 그 결과를 받는 것이다. 

아래의 발표 자료에 CRUD 개념에 맞게 Restful API를 잘 정의하는 방법을 예시로 보여주고 있다.

티켓, 메시지에 대한 operation 정의 예시 (Restful API Best Practices)

• GET /tickets - Retrieves a list of tickets
• GET /tickets/12 - Retrieves a specific ticket
• POST /tickets - Creates a new ticket
• PUT /tickets/12 - Updates ticket #12
• PATCH /tickets/12 - Partially updates ticket #12
• DELETE /tickets/12 - Deletes ticket #12

• GET /tickets/12/messages - Retrieves list of messages for ticket #12
• GET /tickets/12/messages/5 - Retrieves message #5 for ticket #12
• POST /tickets/12/messages - Creates a new message in ticket #12
• PUT /tickets/12/messages/5 - Updates message #5 for ticket #12
• PATCH /tickets/12/messages/5 - Partially updates message #5 for ticket #12
• DELETE /tickets/12/messages/5 - Deletes message #5 for ticket #12

Design Beautiful REST + JSON APIs

by Stormpath

http://www.slideshare.net/stormpath/rest-jsonapis