1장. OpenAPI 사양 소개
Red Hat 3scale API Management에서 OAS(OpenAPI Specification)는 OpenAPI 문서를 최적으로 관리할 수 있도록 지원합니다. OAS(OpenAPI Specification)는 기존 서비스를 업데이트하거나 새 서비스를 생성하는 툴을 제공합니다.
다음은 3scale의 OAS에 대한 특별한 고려 사항입니다.
- 3scale toolbox로 OpenAPI 사양(OpenAPI 문서)을 가져올 수도 있습니다. OpenAPI 정의 가져오기를 참조하십시오.
- OAS 3.0과 관련하여 3scale 2.8이 변경되었습니다. 자세한 내용은 2.1절. “3scale API Management를 사용한 OpenAPI 사양 3.0 사용” 을 참조하십시오.
사전 요구 사항
- API를 정의하는 OpenAPI 문서입니다.
-
3scale 2.15 인스턴스 테넌트의 인증 정보(
token또는provider_key)
OAS를 사용하면 3scale에서 다음 기능을 사용할 수 있습니다.
OpenAPI 문서를 가져올 때 ActiveDocs를 생성하거나 업데이트합니다. 3scale 사양으로 사용하기 위해 OpenAPI 문서를 작성하는 방법을 참조하십시오.
-
3scale 서비스
system_name을 OAS의 기본값인 info.title 필드로 전달하는 선택적 매개변수로 전달하는 기능입니다. 메서드는 OpenAPI 사양에 정의된 각 작업에 대해 생성됩니다.
-
메서드 이름은
operation.operationId필드에서 가져옵니다.
-
메서드 이름은
새 API 정의를 가져오기 전에 기존 매핑 규칙이 모두 삭제됩니다.
- 명령을 실행하기 전에 메서드가 있는 경우 삭제되지 않습니다.
- 매핑 규칙은 OpenAPI 사양에 정의된 각 작업에 대해 생성됩니다.
다음 채널 중 하나는 OpenAPI 정의 리소스를 제공합니다.
- 사용 가능한 경로의 파일 이름입니다.
- URL 형식 - toolbox는 지정된 주소에서 다운로드하려고 합니다.
- stdin 표준 입력 스트림에서 읽습니다.
1.1. 3scale API Management에서 OpenAPI 문서를 가져오는 명령줄 옵션 링크 복사링크가 클립보드에 복사되었습니다!
3scale CLI(명령줄 인터페이스)는 3scale에서 관리하려는 API를 정의하는 OpenAPI 문서를 가져오기 위한 몇 가지 옵션을 제공합니다. 다음은 openapi 옵션에 대한 도움말 정보입니다.