Web API

REST API의 uniform interface를 지원하는 것이 쉽지 않기 때문에, 이를 지원하지 않고 만든 API를 Web API라고 한다.

• uniform interface
  1. 리소스는 URI로 식별되어야 함
  2. HTTP 표현을 이용해 리소스를 생성, 수정, 추가해야 함
  3. 메시지는 스스로 설명할 수 있어야 함
  4. 애플리케이션의 상태는 하이퍼링크를 통해 전이되어야함
     • 3&4 조건이 까다롭다.

API

Application Programming Interface

프로그래밍을 할 때 필요한 인터페이스를 API라고 한다.
API는 사용방법만 잘 숙지하면 내부에 구현된 코드를 몰라도 잘 활용할 수 있다.
파일 처리, 화상 처리, 문자 제어 등등 여러 용도로 제공된다.

HTTP Method

자원을 다루기 위한 표현이다.

• post : 요청하는 리소스를 생성한다.
• GET : 원하는 리소스를 조회한다.
• PUT : 원하는 리소스를 수정한다.
• DELETE : 원하는 리소스를 삭제한다.

규칙

• 언더바(_)는 사용 x
• 하이픈(-)은 가독성을 높이고 싶을 때 사용
• URI 경로는 소문자만 사용해야 한다.
• 파일 확장자를 포함하면 안 된다.
• 슬래시(/)로 계층을 나타낸다.
  • HTTP Method의 하위 계층으로 다른 HTTP Method가 나와서는 안된다.

상태코드

• 20X : 정상적인 수행

  • 200 : 클라이언트의 요청을 성공적으로 수행
  • 201 : 클라이언트가 특정한 리소스를 생성 요청하고 해당 리소스를 성공적으로 생성했을 때

• 40X : 클라이언트로 인한 오류

  • 400 : 클라이언트의 요청이 적절하지 않을 때
  • 401 : 인증되지 않은 클라이언트가 보호된 리소스를 요청했을 때
  • 403 : 서버가 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때
  • 405 사용 불가능한 메서드를 이용했을 경우

• 301 & 500 : 서버로 인한 오류

  • 301 : 요청한 리소스에 대한 URI가 변경되었을 때
  • 500 : 서버에 문제가 생겼을 때