Skip to main content

데이터셋 API 배포

생성한 데이터셋을 배포하고 공개적으로 접근 가능하게 만드는 노드입니다.

설명​

데이터셋 API 배포 노드는 데이터셋을 API 형태로 배포하는 노드입니다.

배포하기를 클릭하면 데이터셋을 확인할 수 있는 URL이 생성됩니다. 그리고 API를 테스트해볼 수 있는 Swagger 문서도 같이 생성됩니다.

포트 구성​

입력 포트​

  • 데이터셋: 배포할 데이터셋

출력 포트​

없음

API 키 발급 및 사용​

배포된 API URL을 사용하려면 API 키를 발급해야 합니다.

API 키 발급하기​

  1. API 키 발급 버튼을 클릭합니다.
  2. API 키에 대한 간단한 설명을 키 이름에 입력합니다.
  3. 이 API 키를 사용할 기간을 설정합니다.
  4. API 키 발급을 클릭합니다.

API 키 발급 화면

API 키 확인 및 복사​

API 키가 생성되면 이 화면에서만 API 키를 확인할 수 있습니다. 키를 복사합니다.

API 키 확인 화면

API 키 사용 방법​

API 키는 Header의 Authorization에 Bearer와 함께 입력합니다.

// 예시
curl -X 'GET' \
  'https://api.ai-canvas.io/external/dataset/ds_92e955c1/preview?page=1&limit=100&sort_order=asc' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer [API KEY]'

API 문서를 통한 테스트​

배포된 API는 Swagger 문서를 통해 테스트할 수 있습니다.

API 문서 접근​

배포 후 생성된 API 문서 링크로 접근하면 API를 테스트해볼 수 있는 화면이 표시됩니다.

API 문서 화면

API 키 인증​

  1. Authorize 버튼을 클릭합니다.
  2. API Key를 입력할 수 있는 화면이 나타납니다.
  3. 발급받은 키를 입력한 뒤 Authorize를 누릅니다.
  4. 정상적으로 로그인이 완료되면 close를 눌러 화면을 닫습니다.

API 키 인증 화면

API 테스트​

API 문서에서 Try it out 버튼을 클릭하면 API를 시험삼아 테스트해볼 수 있습니다.

API 테스트 화면

필터링 방법​

데이터셋 API 배포는 다양한 필터링 방법을 지원합니다.

단순 비교​

column_name=value
또는
column_name[eq]=value

범위 비교​

age[gte]=25
price[lt]=1000

문자열 검색​

name[contains]=kim
email[ends_with]=@gmail.com

목록 필터​

city[in]=seoul,busan,daegu

NULL 체크​

deleted_at[is_null]=true

필터링 연산자​

다음 연산자들을 사용할 수 있습니다:

  • eq (=): 같음
  • ne: 같지 않음
  • gt: 보다 큼
  • gte: 이상
  • lt: 보다 작음
  • lte: 이하
  • contains: 포함
  • not_contains: 포함하지 않음
  • starts_with: 시작
  • ends_with: 종료
  • in: 목록 포함
  • not_in: 목록 제외
  • is_null: NULL 값
  • not_null: NULL이 아님

복합 필터 예시​

여러 필터를 조합하여 사용할 수 있습니다:

?age[gte]=25&gender=male&city[in]=seoul,busan&name[contains]=kim