GraphQL 탐색기를 사용하여 GraphQL API 테스트

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기2분
  • 통합 GraphQL 테스트 도구를 사용하여 GraphQL API를 쿼리합니다.

    시작하기 전에

    GraphQL 스키마 생성.

    내성적 쿼리를 활성화하면 GraphQL Explorer가 Documentation Explorer의 인스턴스에 있는 스키마를 자동 완성 제안으로 표시할 수 있으므로 쿼리 및 변형을 더 쉽게 찾을 수 있습니다. 자세한 내용은 GraphQL 스키마에 대한 내성적 쿼리 사용 문서를 참조하십시오.

    주:
    프로덕션 환경에서 내성적 쿼리를 사용하지 마세요.

    필요한 역할: graphql_schema_admin 또는 admin

    이 태스크 정보

    GraphQL 탐색기는 GraphiQL IDE Now Platform를 . 인터페이스에 대한 자세한 내용은 GraphiQL 리포지토리의 GraphiQLGitHub readme를 참조하십시오.

    프로시저

    1. 다음으로 이동 모두 > 시스템 웹 서비스 > GraphQL > GraphQL 탐색기.
    2. 옵션: 인트로스펙션을 활성화한 경우 왼쪽 사이드바에서 문서 탐색기 표시 아이콘( 문서 탐색기 표시 아이콘)을 선택하여 사용 가능한 쿼리 또는 변형을 보고 검색합니다.
    3. 편집기에서 스키마에 대한 쿼리를 입력합니다.

      쿼리에 응용 프로그램 및 스키마 네임스페이스를 모두 포함합니다. 적용할 수 있는 지시문에 대한 자세한 내용은 을 참조하십시오 지시문 및 전역 함수.

      이 예제에서는 응용 프로그램 및 스키마 네임스페이스를 모두 사용하는 방법을 보여 줍니다.
      • 응용 프로그램 네임스페이스: x_graph_scope
      • 스키마 네임스페이스: planet
      query {
        x_graph_scope {
          planet {
            findAll {
              name
              mass
              distance
            }
          }
        }
      }

      이 예시에서는 @defer 지시문을 사용하여 초기 인시던트 응답 후 openedBy 필드에 대한 결과를 스트리밍하는 방법을 보여줍니다.

      query findIncidents {
        now {
          incident {
            findAll {
              description {
                displayValue
              }
              ...
              @defer(label: "my-label", if: true) {
                openedBy {
                  firstName
                  lastName
                }
              }
            }
          }
        }
      }
    4. 옵션: 편집기 아래쪽에서 변수를 선택하고 필요한 변수를 입력합니다.
    5. 쿼리 실행 아이콘( 쿼리 실행 아이콘)을 선택합니다.
      팁:
      키보드 단축키를 사용할 수도 있습니다. 사용 가능한 바로 가기 키 목록을 보려면 바로 가기 키 대화 상자 열기 아이콘( 짧은 키 대화 상자 열기 아이콘)을 선택합니다.
      쿼리 결과가 오른쪽 창에 반환됩니다.
    6. 옵션: 탭 추가 아이콘( 탭 추가 아이콘)을 선택하여 추가 쿼리를 실행합니다.

    다음에 수행할 작업

    이전 쿼리 목록을 보려면 왼쪽 사이드바에서 기록 표시 아이콘( 기록 표시 아이콘)을 선택합니다.

    구성 요소의 레코드 데이터에 액세스하려면 사용자 지정 구성 요소를 생성하고 구성 요소에서 스크립팅된 GraphQL 스키마를 쿼리할 수 있습니다. 자세한 내용은 구성요소에서 GraphQL 스키마 쿼리 문서를 참조하십시오.