REST API

REST API

---

• 정의
  • REST의 특징을 기반으로 서비스 API를 구현한 것
• 특징
  • 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능하다.
• REST API의 설계 규칙
• 1. URI는 명사를 사용한다.(리소스명은 동사가 아닌 명사를 사용해야 한다.) 1-1. 아래와 같은 동사를 사용하지 말 것 /getAllUsers/getUserById/createNewUser/updateUser/deleteUser 2. 슬래시( / )로 계층 관계를 표현한다. 3. URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다. 4. 밑줄( _ )을 사용하지 않고, 하이픈( - )을 사용한다. 5. URI는 소문자로만 구성한다. 6. HTTP 응답 상태 코드 사용- 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야 한다.HTTP 상태 코드 정리 7. 파일확장자는 URI에 포함하지 않는다. Ex)http://dev-coco.tistory.com/restapi/220/photo.jpg (X)
• REST API vs RESTful API
  • RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 말한다.
  • REST의 원리를 잘 따르는 시스템
  • RESTful하게 만든 API는 요청을 보내는 주소 만으로도 어떤 것을 요청하는지 파악이 가능하다.
  • 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 목적
• REST API
  • URI는 정보의 자원만 표현해야 하며, 자원의 행위는 HTTP Method에 명시한다는 것
  • RESTful API 설계 가이드