API 플레이그라운드

개요

Panther Console의 API Playground에서 GraphQL API와 REST API의 작업을 시험해 볼 수 있습니다.

Playground에 액세스하는 방법

다음을 보유해야 합니다 API 토큰 보기 권한이 있어야 Playground에 액세스할 수 있습니다—참조 Panther의 역할 기반 액세스 제어 사용자 역할 수정 방법은 문서를 참조하세요.

Panther Console의 왼쪽 탐색 모음 하단에서 설정.
다음으로 이동합니다: 개발자 도구 > API 플레이그라운드.
창 상단의 탭을 사용하여 테스트할 API 세트를 선택하세요: GraphQL 또는 REST.
- 다음에 API Playground를 방문하면, 마지막으로 사용하던 API로 이동하게 됩니다.\

참고:

방금 API 토큰을 만들었다면, 새 토큰이 관련 분산 AWS 서비스에서 사용 가능해질 때까지 30~60초 정도 기다려 주세요.
보안상의 이유로, API 토큰은 아닌 페이지를 새로고침하거나 다른 페이지로 이동해도 Playground에 유지됩니다. Playground를 사용할 때마다 API 토큰을 다시 입력해야 합니다.

GraphQL Playground

유효한 API 토큰을 입력한 뒤, 왼쪽 상단의 "play" 아이콘을 클릭하여 GraphQL 쿼리가 실행되도록 강제하세요.

The API Playground's default view shows an example query in a code editor on the left. On the right, there is a column labeled Documentation Explorer.

문서 탐색기

Panther Console의 문서 탐색기는 Panther API 스키마를 살펴보는 한 가지 방법입니다. 다운로드 가능한 스키마 파일을 포함한 다른 방법을 알아보려면 다음을 참조하세요 Panther GraphQL 스키마 알아보기.

다음을 참조하세요 문서 탐색기 Playground 오른쪽에 있습니다. 사용 가능한 쿼리와 뮤테이션을 표시하며, 모든 필드와 엔터티의 설명 및 유형도 함께 보여줍니다:

The image shows the Documentation Explorer that appears on the right side of the API Playground. It has a search field at the top, and a header labeled "Root Types." Under "Root Types," it lists "query: Query" and "mutation: Mutation".

직접 쿼리 작성하기

자동 완성 기능과 문서 탐색기는 직접 쿼리를 작성하는 데 도움이 됩니다. 또한 페이지 상단 근처에는 세 개의 유틸리티 버튼이 있습니다:

예쁘게 정리 GraphQL 표준에 맞게 쿼리를 서식 지정하는 데 도움을 줍니다
복사 요청을 보낼 클라이언트에 붙여넣기 위해 쿼리를 복사하는 데 사용됩니다
curl 복사 curl 명령줄 도구가 설치된 모든 UNIX 시스템에 붙여넣을 수 있는 완전한 curl 작업을 복사합니다.

Panther 웹 애플리케이션에서 복사될 curl 명령의 예:

curl 'PANTHER_GRAPHQL_API_URL' \
-H 'Accept-Encoding: gzip, deflate, br' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Connection: keep-alive' \
-H 'DNT: 1' \
-H 'Origin: http://{PANTHER_GRAPHQL_API_URL}/public/graphql' \
-H 'X-API-Key: {FAKE_API_KEY_WITH_USER_READ_PERMISSIONS}' \
--data-binary '{"query":"\n # 조직의 사용자 목록을 나열하는 예시 쿼리\n query Users {\n users {\n\t\t\tgivenName\n familyName\n email\n }\n }","variables":{}}' \
--compressed

REST Playground

REST Playground를 사용하여 Panther를 살펴보고 시험해 보세요 REST API.

API 토큰 설정 방법

오른쪽 상단에서 다음을 클릭하세요: 권한 부여.\
모달 창에 API 키를 입력하세요.
클릭합니다 권한 부여그다음 닫기.

API 그룹 탐색

API 그룹이 먼저 나열되며, 각 API의 URL 경로별로 함께 모여 있습니다. 요청 인자와 예시 반환 페이로드를 포함해 특정 엔드포인트의 추가 세부 정보를 보려면 해당 엔드포인트 행의 오른쪽에 있는 화살표를 클릭하세요.

Under a header reading "Panther REST API," a grouping of data model endpoints is shown. There are GET (list), POST, DELETE, GET, and PUT endpoints.

요청 보내기

성공적으로 요청하려면 이미 Playground에 API 토큰을 추가해 두어야 합니다. 위의 API 토큰 설정 방법, 위를 참조하세요.

Playground에서 요청을 보내려면:

확장된 API 엔드포인트 내에서 직접 사용해 보기.
다음 매개변수 섹션에서 필요한 매개변수와 선택적 매개변수의 값을 원하는 대로 입력하세요.
클릭합니다 실행.

Within a GET /rules section, a "Try it out" button is circled. Two parameters are shown: cursor, and limit.

스키마 보기

API 그룹 아래에는 각 데이터 유형의 스키마가 나열됩니다:

The Schema section showing all the data types grouped by name

특정 데이터 유형의 세부 정보를 보려면 해당 행을 클릭하여 펼치세요:

A "RuleAPI.Rule" entity is shown. Part of the JSON body is expanded, while other parts are closed.

이 스키마는 다음을 볼 때도 표시됩니다 API 그룹을 볼 때. 응답 섹션, 다음 옆에 예시 값, 다음을 클릭하세요. 스키마.

Inline schema block in the Responses portion of an API Group, showing the datatype where it is used.

이전사용자 및 역할 관리

다음Terraform

마지막 업데이트 1개월 전

도움이 되었나요?