6.3. 플랫폼 게이트웨이 OpenAPI 사양 이해

플랫폼 게이트웨이는 Ansible Automation Platform의 단일 진입점 역할을 하며 사용자 인터페이스를 통합하고 모든 API 트래픽을 자동화 컨트롤러, 이벤트 기반 Ansible 및 자동화 허브와 같은 서비스로 라우팅합니다.

OpenAPI 사양은 플랫폼 게이트웨이를 통해 사용할 수 있는 통합 API 끝점에 대해 표준화되고 시스템에서 읽을 수 있는 정의를 제공합니다. 신뢰할 수 있는 사용자 지정 통합을 구축하는 외부 개발자 및 자동화 엔지니어에게 중요합니다.

사양의 주요 역할

OpenAPI 사양은 다음 역할을 이행하여 성공적으로 통합됩니다.

사용자 지정 통합 활성화: 개발자는 사양을 사용하여 사용자 지정 애플리케이션 및 타사 툴을 빌드하는 데 필요한 끝점 구조, 필수 매개 변수 및 응답 스키마를 파악합니다.
API 수명 확인: 플랫폼 게이트웨이 API와의 통합 - 레거시 직접 액세스 구성 요소 API가 사용 중단될 때 발생할 수 있는 중단에 대해 사용자 정의 애플리케이션을 미래로 보장합니다.
핵심 기능 정의: 사양은 다음을 포함하여 기본 운영 및 관리 기능을 지원하는 끝점을 자세히 설명합니다.
- 플랫폼 상태(예: /api/gateway/v1/status/ )
- 활동 모니터링(예: /api/gateway/v1/activitystream/ )
- 인증 구성 및 역할 기반 액세스 제어 할당과 같은 구성 관리

스키마 엔드포인트에서 curl 명령을 사용하여 OpenAPI 사양을 다운로드할 수 있습니다.

사전 요구 사항

토큰 인증은 프로그래밍 방식의 API 사용에 권장되는 방법입니다.

개인 액세스 토큰 만들기(PAT): 탐색 패널에서 액세스 관리 사용자를 선택하고 사용자를 선택하고 토큰 탭으로 이동한 다음 토큰 생성 을 클릭합니다.
생성된 토큰 값을 복사합니다. 다음 명령에서 이 값을 & lt;OAUTH2_TOKEN_VALUE& gt;로 사용합니다.

프로세스

플랫폼 게이트웨이는 웹 브라우저에서 직접 액세스할 수 있는 OpenAPI 사양의 대화형 렌더링 버전을 제공합니다.

프로세스

다음 URL 구조를 사용하여 문서 끝점으로 이동하여 $AAP_INSTANCE 를 호스트 이름으로 교체합니다.
```
https://$AAP_INSTANCE/api/gateway/v1/docs/
```
사용 가능한 API 엔드포인트를 살펴보고 필요한 매개변수를 보고 플랫폼 게이트웨이에서 노출하는 리소스와의 상호 작용을 테스트합니다.