Red Hat Summit Red Hat Summit지원콘솔개발자평가판 시작연락처

4장. 3scale API Management OpenAPI 사양으로 사용하기 위해 OpenAPI 문서를 작성하는 방법

코드를 읽기만 하려는 경우 모든 예제는 OAS Petstore 예제 소스 코드에 있습니다.

3scale ActiveDocs는 Swagger ( Wordnik)라는 RESTful 웹 서비스의 사양을 기반으로 합니다. 이 예제는 Extended OpenAPI Specification Petstore 예제 를 기반으로 하며 OpenAPI 사양 2.0 사양 문서에서 모든 사양 데이터를 그립니다.

사전 요구 사항

  • 개발자 포털에서 ActiveDocs의 전원을 공급하려면 REST API에 대한 OAS(OpenAPI 사양) 호환 사양이 필요합니다.

OAS는 단순한 사양이 아닙니다. 또한 전체 기능 프레임워크를 제공합니다.

  • 여러 언어(NodeJS, Scala 등)의 리소스 사양을 위한 서버.
  • 사양 파일을 사용하고 매력적인 UI를 생성하는 HTML/CSS/Javascripts 자산 세트입니다.
  • Swagger 호환 서버에서 자동으로 클라이언트 라이브러리를 생성할 수 있는 OAS codegen 프로젝트. 여러 최신 언어로 클라이언트 측 라이브러리 생성 지원

4.1. 3scale API Management ActiveDocs 및 OAS 설정
링크 복사

ActiveDocs는 OAS의 인스턴스입니다. ActiveDocs를 사용하면 자체 OAS 서버를 실행하거나 대화형 문서의 사용자 인터페이스 구성 요소를 처리할 필요가 없습니다. 대화형 문서는 3scale 개발자 포털에서 제공 및 렌더링됩니다.

3scale 2.8에서는 ActiveDocs에서 제한된 지원이 포함된 OAS 3.0을 도입했습니다. 즉, 자동 완성과 같은 ActiveDocs와 함께 작동하는 일부 기능이 아직 완전히 통합되지 않으므로 새 계정을 생성할 때 3scale의 기본값은 OAS 2.0으로 설정됩니다. OAS 3.0 및 ActiveDocs에 대한 자세한 내용은 2.1절. “3scale API Management를 사용한 OpenAPI 사양 3.0 사용” 을 참조하십시오.

사전 요구 사항

  • 개발자 포털에 사용된 템플릿이 관리 포털에 지정된 동일한 OAS 버전을 구현하는지 확인합니다.

프로세스

  1. OAS와 호환되는 API 사양을 빌드합니다.
  2. 관리 포털에 사양을 추가합니다.

결과

이제 API에 대한 대화형 문서를 사용할 수 있습니다. API 소비자는 개발자 포털을 통해 API에 요청을 보낼 수 있습니다.

API의 OAS 호환 사양이 이미 있는 경우 개발자 포털에 추가할 수 있습니다. ActiveDocs 구성에 대한 튜토리얼을 참조하십시오.

3scale은 여러 가지 방법으로 OAS를 확장하여 개발자 포털 대화형 API 문서에 필요한 특정 기능을 수용합니다.

  • API 키 자동 채우기.
맨 위로 이동
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

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

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

Red Hat 소개

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

Theme

© 2025 Red Hat