Application Programming Interface

API🍎

한 프로그램에서 다른 프로그램으로 데이터를 주고 받기 위한 표준화된 방법
식당과 손님 사이의 메뉴판이라고 생각하면 된다.

API는 HTTP 요청 방식(GET, POST, PUT, DELETE 등), 요청할 데이터(endpoint), 응답 형식(JSON, XML)을 정의한다.

API가 가져야 할 주요 구성 요소

1. 요청 방식(Method)

• GET: 데이터를 요청하는 경우
• POST: 새로운 데이터를 생성하는 경우
• PUT: 기존 데이터를 수정하는 경우
• DELETE: 데이터를 삭제하는 경우

2. 요청 데이터(Endpoint)

• 웹툰, 댓글, 뉴스 등 어떤 데이터를 요청할지 명시
• 일반적으로 URL 경로로 표현 (http://comic.naver.com/webtoon/detail?titleId=12345)

3. 추가 정보

• 요청에 필요한 추가 데이터
  (예: titleID=12345)
• 인증 토큰, 페이지 번호 등 다양한 정보가 포함될 수 있음

4. REST API 원칙

• 웹에서는 주로 REST API 원칙에 따라 API를 작성
• HTTP 메서드(GET, POST, PUT, DELETE)를 적절히 사용
• 리소스 지향적 URL 설계
• JSON 형식의 응답 데이터 제공

---

⌨️ API 명세 ⌨️

API의 기능, 사용 방법, 요청/응답 데이터 구조 등을 문서화한 것

• Endpoint
• 요청 데이터
• 응답 데이터
• 오류 처리 <에러코드, 에러 메시지 등>
• 인증/권한 <인증 방식, 접근 권한 등>
• 샘플 코드
  • API 호출 예시

---

API 호출

브라우저의 URL 입력란(GET 요청) -> API 요청 코드를 작성하는 곳
HTML 내의 버튼 클릭 등으로 자동으로 API 요청 코드가 실행되도록 구현

API 종류

Public API / Private API / Partner API