search
Knowledge BaseRelease NotesRequest Demo

API 플레이그라운드

hashtag
개요

Panther 콘솔의 API 플레이그라운드에서 GraphQL API 및 REST API의 작업을 시도해 볼 수 있습니다.

hashtag
플레이그라운드에 접근하는 방법

circle-info

다음 권한이 있어야 합니다 API 토큰 보기 플레이그라운드에 접근하려면—사용자 역할 수정 방법은 Panther의 역할 기반 접근 제어 문서에서 확인하세요.

  1. Panther 콘솔의 오른쪽 상단 모서리에서 톱니바퀴 아이콘을 클릭하세요.

  2. 드롭다운 메뉴에서 클릭하세요 API 플레이그라운드.

  3. 창 상단의 탭을 사용하여 테스트하려는 API 세트를 선택하세요: GraphQL 또는 REST.

    • 다음 번에 API 플레이그라운드를 방문하면 이전에 사용하던 API가 자동으로 열립니다.\

      Two tabs are shown: GraphQL and REST.
circle-exclamation

참고:

  • 방금 API 토큰을 생성한 경우, 관련된 분산 AWS 서비스에서 새 토큰이 이용 가능해지기까지 30~60초 정도 기다려 주세요.

  • 보안상의 이유로 API 토큰은 저장되지 페이지를 새로 고치거나 다른 페이지로 이동하면 플레이그라운드에 유지되지 않습니다. 플레이그라운드를 사용할 때마다 API 토큰을 다시 입력해야 합니다.

hashtag
GraphQL 플레이그라운드

유효한 API 토큰을 입력한 후 왼쪽 상단의 "재생" 아이콘을 클릭하면 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.

hashtag
문서 탐색기

Panther 콘솔의 문서 탐색기는 Panther API 스키마를 검사하는 한 가지 방법입니다. 다운로드 가능한 스키마 파일을 포함한 다른 방법을 보려면 Panther GraphQL 스키마 알아보기.

오른쪽에 있는 문서 탐색기 플레이그라운드의 오른쪽에 표시됩니다. 사용 가능한 쿼리와 뮤테이션을 각 필드 및 엔티티의 설명과 타입과 함께 표시합니다:

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".

hashtag
직접 쿼리 작성하기

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

  • 정리(Prettify) GraphQL 표준에 따라 쿼리 형식을 정리하는 데 도움을 줍니다

  • 복사 요청을 발행할 클라이언트에 붙여넣을 수 있도록 쿼리를 복사합니다

  • curl 복사 curl 명령줄 도구가 설치된 모든 UNIX 시스템에 붙여넣을 수 있는 완전한 curl 작업을 복사합니다.

Panther 웹 애플리케이션에서 복사되는 curl 명령 예시:

hashtag
REST 플레이그라운드

REST 플레이그라운드를 사용하여 Panther의 REST API.

hashtag
API 토큰을 설정하는 방법

  1. 오른쪽 상단에서 클릭하세요 인증(Authorize).\

    An arrow is drawn to a button labeled "Authorize."

  2. 모달에서 API 키를 입력하세요.

  3. 클릭하세요 인증(Authorize)그런 다음 닫기.

hashtag
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.

hashtag
요청 보내기

circle-info

성공적인 요청을 하려면 플레이그라운드에 이미 API 토큰을 추가했어야 합니다. 위의 API 토큰을 설정하는 방법를 참조하세요.

플레이그라운드에서 요청을 보내려면:

  1. 확장된 API 엔드포인트 내에서 클릭하세요 지금 시도(Try it out).

  2. 에서 매개변수(Parameters) 섹션에서 필요에 따라 필수 및 선택 매개변수의 값을 제공하세요.

  3. 클릭하세요 실행(Execute).

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

hashtag
스키마 보기

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 그룹을 볼 때볼 수 있습니다. In the 응답(Responses) 섹션에서, 예시 값(Example Value)옆에 있는 스키마.

Inline schema block in the Responses portion of an API Group, showing the datatype where it is used.
이전사용자 및 역할 관리다음Terraform

마지막 업데이트

도움이 되었나요?