[CS] API

API

---

- 정의 및 프로토콜 집합을 사용하여 두 S/W 구성 요소가 서로 통신할 수 있게 하는 메커니즘

- REST API를 보편적으로 많이 사용함

 

REST API (Representational State Transfer API)

---

- 클라이언트가 서버에 요청을 데이터로 전송하고, 그 서버가 이 클라이언트 입력을 사용하여 내부 함수를 시작하고 출력 데이터를

클라이언트에 반환함

- 무상태(서버가 요청 간에 클라이언트 데이터를 저장하지 않음)

- 구성

• 자원(Resource) : URL
• 행위(Verb) : HTTP Method
• 표현(Representations)

 

HTTP METHOD

---

- HTTP METHOD에는 POST, GET, PUT, DELETE가 있음

• POST : URL를 요청하면 리소스를 생성
• GET : 해당 리소스를 조회, 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옴
• PUT : 해당 리소스 수정
• DELETE : 리소스 삭제

 

- HTTP 응답 상태 코드

• 200 ~ 300 : 클라이언트 요청을 정상적으로 수행
• 201 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST)
• 301 : 클라이언트가 요청한 리소스에 대한 URL이 변경 되었을 때 사용하는 응답 코드
• 400~ : 클라이언트의 요청이 부적절하거나 문제가 생겼을 떄 사용하는 응답 코드

 

 

참고

REST API 제대로 알고 사용하기 : NHN Cloud Meetup

API란 무엇인가요? - 애플리케이션 프로그래밍 인터페이스 설명 - AWS