Red Hat Summit3장. 3scale에 ActiveDocs 추가
3scale은 API에 대한 대화형 문서를 만들 수 있는 프레임워크를 제공합니다.
O AS(OpenAPI Specification) 에는 개발자가 API를 탐색, 테스트 및 통합하는 데 도움이 되는 API에 대한 기능 문서가 있습니다.
3.1. 3scale에서 ActiveDocs 설정
3scale 사용자 인터페이스의 API에 ActiveDocs를 추가하여 API의 대화형 문서를 생성하기 위한 프레임워크를 가져올 수 있습니다.
사전 요구 사항
- API를 정의하는 OpenAPI 문서입니다.
-
3scale 2.11 인스턴스 테넌트의 자격 증명(
토큰또는provider_key).
절차
관리 포털의 [your_API_name]
ActiveDocs 로 이동합니다. 3scale에는 API에 대한 서비스 사양 목록이 표시됩니다. 처음에는 비어 있습니다. 원하는 만큼 많은 서비스 사양을 추가할 수 있습니다. 일반적으로 각 서비스 사양은 API 중 하나에 해당합니다. 예를 들어 3scale에는 서비스 관리, 계정 관리, 분석 및 청구와 같은 3scale API에 대한 사양이 있습니다.
Create a new spec (새 사양 만들기)을 클릭합니다.
새 서비스 사양을 추가할 때 다음을 제공합니다.
- 이름
- 시스템 이름. 이는 개발자 포털의 서비스 사양을 참조하는 데 필요합니다.
사양을 게시할지 여부를 선택합니다. 게시하지 않으면 새 사양은 개발자 포털에서 사용할 수 없습니다.
참고를 생성하지만 새 사양을 게시하지 않으면 선택한 나중에 게시할 수 있는 상태로 유지됩니다.
- 사용자의 소비용으로만 사용되는 설명을 추가합니다.
API JSON 사양을 추가합니다.
O AS(OpenAPI Specification) 에서 제안한 사양에 따라 API 사양을 생성합니다. 이 튜토리얼에서는 이미 API의 유효한 OAS 준수 사양을 가지고 있다고 가정합니다.
첫 번째 ActiveDoc 작업
첫 번째 ActiveDoc을 추가한 후 [your_API_name]
서비스 사양(예: Pet Store)을 선택한 이름을 클릭하여 ActiveDocs의 상태를 미리 볼 수 있습니다. 사양이 아직 게시되지 않았더라도 이 작업을 수행할 수 있습니다.
ActiveDoc은 다음과 같습니다.
