3장. 3scale에 ActiveDocs 추가


3scale은 API에 대한 대화형 문서를 작성하는 프레임워크를 제공합니다.

OAS(OpenAPI Specification) 를 사용하면 API에 대한 기능 문서가 있어 개발자가 API를 탐색하고 테스트 및 통합할 수 있습니다.

3.1. 3scale에서 ActiveDocs 설정

3scale 사용자 인터페이스의 API에 ActiveDocs를 추가하여 API에 대한 대화형 문서를 만들기 위한 프레임워크를 가져올 수 있습니다.

사전 요구 사항

  • API를 정의하는 OpenAPI 문서입니다.
  • 3scale 2.13 인스턴스 테넌트의 인증 정보(token 또는 provider_key).

절차

  1. 관리 포털에서 [your_API_name] ActiveDocs 로 이동합니다. 3scale은 API의 서비스 사양 목록을 표시합니다. 처음에는 비어 있습니다.

    원하는 만큼 서비스 사양을 추가할 수 있습니다. 일반적으로 각 서비스 사양은 API 중 하나에 해당합니다. 예를 들어 3scale에는 서비스 관리, 계정 관리, 분석 및 청구와 같은 3scale API 각각에 대한 사양이 있습니다.

  2. 새 사양 생성을 클릭합니다.

    새 서비스 사양을 추가할 때 다음을 제공합니다.

    • 이름
    • 시스템 이름. 개발자 포털에서 서비스 사양을 참조하는 데 필요합니다.
    • 사양을 게시할지 여부를 선택합니다. 게시하지 않으면 개발자 포털에서 새 사양을 사용할 수 없습니다.

      참고

      새 사양을 만들 수는 없지만 새 사양을 게시하지 않으면 나중에 선택한 시점에 게시에 계속 사용할 수 있습니다.

    • 사용 용도로만 사용할 수 있는 설명을 추가합니다.
    • API JSON 사양을 추가합니다.

      OAS(OpenAPI Specification) 에서 제안한 사양에 따라 API 사양을 생성합니다. 이 튜토리얼에서는 이미 API의 유효한 OAS 호환 사양이 있다고 가정합니다.

첫 번째 ActiveDoc로 작업

첫 번째 ActiveDoc을 추가한 후 [your_API_name] ActiveDocs 에 나열된 것을 확인할 수 있습니다. 필요에 따라 편집하거나, 삭제하거나, public에서 private로 전환할 수 있습니다. API에서 분리하거나 다른 API에 연결할 수 있습니다. NetNamespace → 개발자 포털 ActiveDocs에서 API에 연결되어 있는지 여부에 관계없이 모든 ActiveDocs 를 볼 수 있습니다.

서비스 사양을 제공한 이름을 클릭하여 ActiveDocs가 어떻게 보이는지 미리 볼 수 있습니다(예: Pet Store). 사양이 아직 게시되지 않은 경우에도 이 작업을 수행할 수 있습니다.

ActiveDoc의 예는 다음과 같습니다.

ActiveDocs 새로운 사양 보기
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 문서 정보

Legal Notice

Theme

© 2026 Red Hat
맨 위로 이동