API 탐색기

API 탐색기는 프로젝트의 GraphQL API를 탐색하기 위한 브라우저 내 IDE입니다. Archie Core 개발자가 작업 공간 내에서 GraphQL 쿼리를 쉽게 구축하고 실행할 수 있게 해줍니다.

API 탐색기는 실제 프로덕션 데이터를 사용합니다.

인트로스펙션

GraphQL 스키마에는 스키마 구조를 게시하는 내장 인트로스펙션 시스템이 있습니다. 이를 통해 API 탐색기는 GraphQL 쿼리를 작성할 때 강력한 자동 완성 기능을 제공할 수 있습니다.

items 블록 내부에서 **“em”**을 입력하세요. 여기서 API의 사용 가능한 작업에서 email 필드를 쉽게 보고 선택할 수 있습니다. 자동 완성은 구축 중인 쿼리의 위치에 따라 컨텍스트에 맞게 작동하며, 입력 중인 내용에 따라 옵션을 필터링합니다.

자동 완성 메뉴를 수동으로 활성화하고 사용 가능한 옵션을 보려면 [Shift] + [SPACE] 키 조합을 누르세요. 이 작업은 컨텍스트 메뉴를 표시하여 목록에서 원하는 필드(예: items)를 선택할 수 있게 합니다.

또한 인트로스펙션은 쿼리의 오류를 감지하는 데 도움이 됩니다. 시스템은 다른 유형을 사용할 수 없거나 잘못 구성되었을 때를 인식합니다. 따라서 API 탐색기를 사용할 때 빨간색 물결 선 위에 마우스를 올려 오류 툴팁을 확인하세요.

API 문서 액세스

API 탐색기에는 쿼리를 작성하는 동안 데이터 모델을 이해하는 데 도움이 되는 내장 스키마 참조가 포함되어 있습니다.

1. 문서 패널

오른쪽 상단 도구 모음에 있는 Documentation 버튼을 클릭하세요.

2. 컨텍스트 빠른 탐색

입력 중인 특정 필드의 문서로 직접 이동할 수 있습니다.

작성기

작성기는 일반적으로 API 탐색기의 왼쪽에 기본적으로 열려 있는 시각적 쿼리 구축 도구입니다.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}