Introduction to APIs

API의 위대한 세계에 오신 것을 환영합니다!

이 문서에서는 다음과 같은 내용을 학습합니다:* API란 무엇인가요* RESTful API란 무엇인가요* Tulip의 API로 작업하는 방법

API란 무엇인가요?

API (애플리케이션 프로그래밍 인터페이스)는 서로 다른 소프트웨어 컴포넌트가 통신하고 데이터를 전송할 수 있게 해주는 프로토콜 집합입니다.

개발자는 API를 사용하여 작고 개별적인 코드 덩어리 사이의 간극을 메워 강력하고 탄력적이며 안전하며 사용자 요구를 충족할 수 있는 애플리케이션을 만듭니다.

API에는 네 가지 핵심 부분이 있습니다.1. API 클라이언트 - API 요청을 시작하는 방법.2. API 요청 - API가 작업을 수행하거나 사용자에게 정보를 제공하도록 요청하는 것.3. API 서버 - 요청의 출처와 요청이 제대로 작성되었는지 확인하고 요청된 데이터를 검색하거나 조작하는 것.4. API 응답 - 사용자(클라이언트)에게 되돌아오는 응답입니다.

API 요청

API 요청은 크게 다섯 가지로 구성됩니다:

엔드포인트: 특정 리소스에 대한 액세스를 제공하는 전용 URL입니다. 예를 들어 /tables 엔드포인트를 사용하면 모든 튤립 테이블을 가져오거나 새 튤립 테이블을 만들 수 있습니다.
메서드: API가 수행하려는 작업 유형입니다. Tulip은 REST API를 사용하므로 GET, PUT, POST 및 DELETE로 제한됩니다.
파라미터: API가 처리할 특정 지침을 제공하기 위해 API 엔드포인트로 전달되는 변수입니다. 앞의 /tables 엔드포인트 예제에서 확장하여, /tables/{tableId}를 통해 특정 테이블 ID를 지정할 수 있습니다. 또한 매개변수를 추가로 수정할 수 있는 쿼리도 있습니다.
요청 헤더: 콘텐츠 유형이나 인증 자격 증명 등 요청에 대한 세부 정보를 제공하는 키-값 쌍입니다.
요청 본문: 리소스를 생성, 업데이트 또는 삭제하는 데 필요한 데이터를 자세히 설명하는 요청의 주요 부분입니다. 예를 들어, 스테이션 URL에서 새 스테이션을 요청하고 어떤 스테이션 그룹에 속해야 하는지, 어떤 앱을 포함할 수 있는지 자세히 설명할 수 있습니다.

API 응답

REST 요청을 성공적으로 구성하여 전송하면 서버는 다음과 같은 응답을 보냅니다:

상태 코드: API 요청의 결과를 나타내는 3자리 코드입니다.
응답 헤더: 서버의 응답에 대한 추가 정보를 제공합니다.
응답 본문: 응답 본문에는 클라이언트가 요청한 실제 데이터나 콘텐츠, 또는 문제가 발생한 경우 오류 메시지가 포함됩니다.

일반적인 HTTP 상태 코드는 다음과 같습니다:

200 OK: 요청이 성공했으며 응답 본문에 요청된 리소스가 포함되어 있음을 나타냅니다**.404 찾을 수 없음**: URL을 잘못 입력했거나 리소스가 이동 또는 삭제되어 서버가 요청된 리소스를 찾을 수 없음을 나타냅니다**.400 잘못된 요청**: 잘못된 구문이나 요청에 필수 매개변수 누락 등의 클라이언트 오류로 인해 서버가 요청을 처리할 수 없음을 나타냅니다**.500 내부 서버 오류**: 서버가 요청을 처리할 수 없는 예기치 않은 조건(일반적으로 클라이언트가 제어할 수 없는 서버 측 문제)이 발생했음을 나타냅니다**.302 발견됨(일시적으로 이동됨**): 요청된 리소스가 일시적으로 다른 URL로 이동되었음을 나타냅니다. 클라이언트는 응답 헤더에 제공된 새 URL로 다시 요청해야 합니다**.401 권한이 없음**: 요청에 사용자 인증이 필요하지만 클라이언트가 유효한 자격 증명을 제공하지 않았거나 아직 인증하지 않았음을 나타냅니다.

HTTP 오류 코드에 대한 자세한 내용은 여기에서 확인하세요.

RESTful API란 무엇인가요?

Tulip은 RESTful API를 사용합니다. 다른 유형의 API로는 SOAP, GraphQL, Webbhook 또는 gRPC 등이 있습니다.

RESTful API라고도 하는 REST API는 웹 URL을 통해 데이터, 콘텐츠, 알고리즘, 미디어 및 기타 디지털 리소스를 사용할 수 있도록 하는 데 사용되는 간단하고 통일된 인터페이스입니다. REST API는 오늘날 웹에서 가장 일반적으로 사용되는 API입니다.

REST API는 네 가지 주요 메서드를 사용합니다.1. GET: 이 방법을 사용하면 서버가 요청한 데이터를 찾아서 사용자에게 다시 전송합니다.2. PUT: PUT 요청을 수행하면 서버가 데이터베이스의 항목을 업데이트합니다.3. POST: 서버가 데이터베이스에 새 항목을 생성할 수 있습니다.4. DELETE: 서버가 데이터베이스의 항목을 삭제할 수 있습니다.

Tulip의 API로 작업하는 방법

다음 문서를 읽고 Tulip에서 API 사용 및 테스트를 시작하세요:

원하는 것을 찾았나요?