Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Apollo API Explorer

Apollo는 일부 API를 GraphQL로 제공합니다. GraphQL은 응답에서 필요한 필드를 지정하여 데이터를 조회하는 언어입니다. 허브의 API Explorer 애플리케이션에서 요청을 작성하고, 해당 허브가 제공하는 스키마를 탐색할 수 있습니다.

스키마 탐색

문서 탐색기(documentation explorer)는 루트 query와 mutation에서 시작하여 중첩된 유형과 필드로 이동하는 검색 가능한 화면입니다. 조회할 필드, 입력 인수와 반환 구조를 이 화면에서 확인합니다.

query는 데이터를 조회하고 mutation은 리소스를 변경하는 작업입니다. 작업에 필요한 권한은 API에도 적용됩니다. 실제 허브의 스키마에서 제공되는 필드와 인수를 사용하며, 화면에 이름이 보인다는 이유만으로 모든 리소스를 읽거나 바꿀 수 있는 것은 아닙니다.

현재 사용자 조회

다음 query는 현재 요청 사용자의 ID와 전체 이름을 선택합니다.

query GetCurrentUser {
  me {
    id
    fullName
  }
}

me 아래에 명시한 필드만 요청하므로 다른 사용자 속성이 필요하면 스키마에서 지원 필드를 확인하여 추가합니다.

환경 한 페이지 조회

다음 query는 배포 환경(Environment) 최대 100개가 있는 한 페이지에서 ID를 가져오는 예시입니다.

query GetEnvironments {
  apollo {
    environments(pageSize: 100) {
      environments {
        id
      }
    }
  }
}

이는 허브의 모든 환경을 끝까지 순회하는 요청이 아닙니다. 추가 페이지나 다른 속성이 필요하면 현재 스키마의 페이지 처리 인수와 결과 필드를 확인합니다. 인증된 사용자가 접근할 수 있는 범위의 결과를 사용합니다.