Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.

이 버전의 GitHub Enterprise는 다음 날짜에 중단됩니다. 2023-03-15. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 성능 향상, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.

Explorer 사용

문서, 구문 강조 표시, 유효성 검사 오류가 포함된 브라우저의 통합 개발 환경인 GraphQL Explorer를 사용하여 실제 GitHub 데이터에 대한 쿼리를 실행할 수 있습니다.

GraphQL Explorer 정보

이 설명서에서 GraphQL Explorer라고도 하는 GraphiQL은 “그래픽 대화형 브라우저 내 GraphQL IDE”입니다.

GraphiQL 사용

GraphiQL 앱을 사용하려면 https://github.com/skevy/graphiql-app 에서 다운로드하여 설치합니다.

GraphiQL 구성

  1. OAuth 토큰을 가져옵니다.
  2. GraphiQL을 시작합니다.
  3. GraphiQL의 오른쪽 위 모서리에서 HTTP 헤더 편집을 클릭합니다.
  4. 필드에 Authorization를 입력합니다. 필드에 Bearer <token>을 입력합니다, 여기서 <token>은 생성된 OAuth 토큰입니다. graphiql 헤더
  5. 토큰의 오른쪽에 있는 확인 표시를 클릭하여 저장합니다.
  6. 편집기로 돌아가려면 HTTP 헤더 편집 모달의 바깥쪽을 클릭합니다.
  7. GraphQL 엔드포인트 필드에 http(s)://<em>HOSTNAME</em>/api/graphql을 입력합니다.
  8. 메서드 드롭다운 메뉴에서 POST를 선택합니다.

참고: POST가 메서드인 이유에 대한 자세한 내용은 “GraphQL과 통신”을 참조하세요.

직접 쿼리하여 액세스를 테스트할 수 있습니다.

query {
  viewer {
    login
  }
}

모든 것이 올바르게 작동하면 로그인이 표시됩니다. 쿼리 만들기를 시작할 준비가 완료되었습니다.

사이드바 문서에 액세스

GraphQL 스키마의 모든 형식에는 문서로 컴파일된 description 필드가 포함됩니다. Explorer 페이지의 오른쪽에 있는 축소 가능한 문서 창을 사용하면 형식 시스템에 대한 설명서를 찾아볼 수 있습니다. 문서는 자동으로 업데이트되며 사용되지 않는 필드를 삭제합니다.

문서 사이드바에는 “참조” 아래의 스키마에서 자동으로 생성되는 동일한 콘텐츠가 포함되어 있지만 형식은 위치마다 다릅니다.

변수 창 사용

일부 예제 호출에는 다음과 같이 작성된 변수가 포함됩니다.

query($number_of_repos:Int!){
  viewer {
    name
     repositories(last: $number_of_repos) {
       nodes {
         name
       }
     }
   }
}
variables {
   "number_of_repos": 3
}

줄 바꿈을 이스케이프하는 한 명령의 요청을 사용하여 POST 호출을 curl 제출하는 올바른 형식 입니다.

Explorer에서 호출을 실행하려면 기본 창에 query 세그먼트를 입력하고 그 아래에 있는 쿼리 변수 창에 변수를 입력합니다. Explorer에서 단어 variables를 생략합니다.

{
   "number_of_repos": 3
}

지원 요청

GitHub Apps, OAuth Apps 및 API 개발에 대한 질문, 버그 보고서 및 토론은 GitHub 커뮤니티에 대한 API 및 통합 토론을(를) 살펴보세요. 토론은 GitHub 직원에 의해 조정되고 유지 관리되지만 포럼에 게시된 질문은 GitHub 직원으로부터 회신을 받을 수 없습니다.

연락처 양식을 사용하여 GitHub 지원에 직접 연락하는 것이 좋습니다.

  • GitHub Enterprise Server 직원의 보장된 응답
  • 중요한 데이터 또는 개인 문제와 관련된 지원 요청
  • 기능 요청
  • GitHub Enterprise Server 제품에 대한 피드백

문제 해결 오류

GraphQL은 내적이므로 Explorer는 다음을 지원합니다.

  • 현재 스키마를 인식하는 지능형 자동 완성
  • 입력할 때 유효성 검사 오류 미리 보기

형식이 올바르지 않거나 스키마 유효성 검사를 통과하지 않은 쿼리를 입력하면 팝업에서 오류를 경고합니다. 쿼리를 실행하면 응답 창에서 오류가 반환됩니다.

GraphQL 응답에는 data 해시 및 errors 배열과 같은 여러 키가 포함됩니다.

{
  "data": null,
  "errors": [
    {
      "message": "Objects must have selections (field 'nodes' returns Repository but has no selections)",
      "locations": [
        {
          "line": 5,
          "column": 8
        }
      ]
    }
  ]
}

스키마와 관련이 없는 예기치 않은 오류가 발생할 수 있습니다. 이 경우 메시지에는 이슈를 보고할 때 사용할 수 있는 참조 코드가 포함됩니다.

{
  "data": null,
  "errors": [
    {
      "message": "Something went wrong while executing your query. This is most likely a GitHub bug. Please include \"7571:3FF6:552G94B:69F45B7:5913BBEQ\" when reporting this issue."
    }
  ]
}

참고: GitHub에서는 프로덕션 환경에서 데이터를 사용하기 전에 오류를 확인할 것을 권장합니다. GraphQL에서 실패는 전체가 아닙니다. GraphQL 쿼리의 일부는 성공하고 나머지는 실패할 수 있습니다.