API

API

• Application Programming Interface의 약자
• API(Application Programming Interface, 응용 프로그램 프로그래밍 인터페이스)는 응용 프로그램에서 사용할 수 있도록, 운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 인터페이스를 뜻함
• 주로 파일 제어, 창 제어, 화상 처리, 문자 제어 등을 위한 인터페이스를 제공
• 프로그래밍을 할 때 필요한 인터페이스를 API라고 함.

Rest API

• Representational State Transfer
• REST API란 말 그대로 REST 형식의 API를 말함
• REST API란 핵심 컨텐츠 및 기능을 외부 사이트에서 활용할 수 있도록 제공되는 인터페이스

Web API

• URI는 정보의 자원을 표현해야함
• 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현

규칙

• URI 마지막 문자로 슬래시 구분자를 포함하지 않음
• 하이픈(-)은 URI 가독성을 높일 때 사용
• 언더바(_)는 사용하지 않음
• URI경로는 소문자만 사용

상태코드

• 200: 클라이언트의 요청을 정상적 수행
• 201: 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

상태 코드(클라이언트로 인한 오류)

• 400: 클라이언트의 요청이 부적절할 경우 사용하는 응답 코드
• 401: 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
  • 록그인하지 않은 유저가, 로그인 했을 때 요청 가능한 리소스를 요청했을 때
• 403: 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
• 405: 클라이언트가 요청한 리소스에서는 사용 불가능한 Method 를 이용했을 경우 사용하는 응답 코드

상태 코드(서버로 인한 오류)

• 301: 클라이언트가 요청한 리소스에 대한 URI가 변경되었을 때, 사용
• 500: 서버에 문제가 있을 경우