8.6. 3scale OpenAPI 사용자 정의 리소스 배포
OpenAPI CR(사용자 정의 리소스)은 개발자 포털의 ActiveDocs에 사용할 수 있는 OAS(OpenAPI 사양) 문서를 가져오는 한 가지 방법입니다. OAS는 API에 하나의 특정 프로그래밍 언어를 사용하도록 연결하지 않는 표준입니다. 사람과 컴퓨터는 소스 코드 액세스, 문서 또는 네트워크 트래픽 검사없이 API 제품의 기능을 더 쉽게 이해할 수 있습니다.
사전 요구 사항
- 3scale 2.14 On-Premises 인스턴스에 대한 관리자 권한이 있는 사용자 계정.
- API를 정의하는 OAS 문서입니다.
-
OpenAPICR이 테넌트에 연결하는 방법에 대한 이해
8.6.1. 시크릿에서 OAS 문서를 가져오는 3scale OpenAPI 사용자 정의 리소스 배포 링크 복사링크가 클립보드에 복사되었습니다!
3scale 백엔드 및 제품을 생성할 수 있도록 OpenAPI CR(사용자 정의 리소스)을 배포합니다.
Operator는 시크릿의 콘텐츠만 읽습니다. Operator는 시크릿에서 필드 이름을 읽지 않습니다.
사전 요구 사항
3scale Operator가 사용자 지정 리소스가 연결되는 테넌트를 식별하는 방법을 이해할 수 있습니다.
절차
OAS 문서가 포함된 시크릿을 정의합니다. 예를 들어 이 콘텐츠를 사용하여
myoasdoc1.yaml을 생성할 수 있습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 시크릿을 생성합니다. 예를 들어 다음과 같습니다.
oc create secret generic myoasdoc1 --from-file myoasdoc1.yaml
$ oc create secret generic myoasdoc1 --from-file myoasdoc1.yaml secret/myoasdoc1 createdCopy to Clipboard Copied! Toggle word wrap Toggle overflow OpenAPICR을 정의합니다. OAS 문서가 포함된 보안에 대한 참조를 지정해야 합니다. 예를 들어myopenapicr1.yaml파일을 생성할 수 있습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 방금 정의한 리소스를 만듭니다. 예를 들어 다음과 같습니다.
oc create -f myopenapicr1.yaml
$ oc create -f myopenapicr1.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 지정된 예에서 출력은 다음과 같습니다.
openapi.capabilities.3scale.net/myopenapicr1 created
openapi.capabilities.3scale.net/myopenapicr1 createdCopy to Clipboard Copied! Toggle word wrap Toggle overflow
8.6.2. 3scale OpenAPI 사용자 정의 리소스 정의 기능 링크 복사링크가 클립보드에 복사되었습니다!
OpenAPI CRD(사용자 정의 리소스 정의) 배포 기능에 대한 지식이 있으면 3scale 제품, 백엔드 및 이후 개발자 포털용 ActiveDocs 생성을 구성할 수 있습니다.
OAS 문서는 다음에서 읽을 수 있습니다.
- Kubernetes 시크릿
- http 및 https 형식의 URL
-
OAS 문서에서
info.title설정은 215자를 초과해서는 안 됩니다. Operator는 이 설정을 사용하여 긴 제한이 있는 OpenShift 오브젝트 이름을 생성합니다. -
서버 목록의 첫 번째
servers[0].url요소만 개인 URL로 구문 분석됩니다. OpenAPI Specification (OAS)은servers[0].url요소의basePath구성 요소를 사용합니다. -
OpenAPICRD는 단일 최상위 보안 요구 사항을 지원하지만 운영 수준 보안은 지원하지 않습니다. -
OpenAPICRD는apiKey보안 스키마를 지원합니다.
8.6.3. OpenAPI 사용자 정의 리소스 정의 시 규칙 가져오기 링크 복사링크가 클립보드에 복사되었습니다!
가져오기 규칙은 3scale 배포에 대한 OpenAPI 문서를 설정할 때 OAS(OpenAPI 사양)에서 3scale과 작동하는 방식을 지정합니다.
제품 이름
기본 제품 시스템 이름은 OpenAPI 문서의 info.title 필드에서 가져옵니다. OpenAPI 문서의 제품 이름을 재정의하려면 OpenAPI CR(사용자 정의 리소스)에서 spec.productSystemName 필드를 지정합니다.
개인 기본 URL
개인 기본 URL은 OpenAPI CR servers[0].url 필드에서 읽습니다. OpenAPI CR에서 spec.privateBaseURL 필드를 사용하여 이 값을 덮어쓸 수 있습니다.
3scale 방법
가져온 OpenAPI 문서에 정의된 각 작업은 제품 수준에서 하나의 3scale 메서드로 변환됩니다. 메서드 이름은 작업 오브젝트의 operationId 필드에서 읽습니다.
3scale 매핑 규칙
가져온 OpenAPI 문서에 정의된 각 작업은 제품 수준에서 하나의 3scale 매핑 규칙으로 변환됩니다. 이전에는 기존 매핑 규칙이 OpenAPI CR로 가져온 규칙으로 교체됩니다.
OpenAPI 문서에서 경로 오브젝트는 동사 및 패턴 속성에 대한 매핑 규칙을 제공합니다. 3scale 방법은 operationId 에 따라 연관됩니다.
value는 1 로 하드 코딩됩니다.
기본적으로 Strict matching 정책이 구성됩니다. 일치하는 정책은 OpenAPI CRD의 spec. PrefixMatching 필드를 사용하여 일치하는 Prefix로 전환할 수 있습니다.
인증
하나의 최상위 보안 요구 사항만 지원됩니다. 작업 수준 보안 요구 사항은 지원되지 않습니다.
지원되는 보안 스키마는 apiKey 입니다.
apiKey 보안 스키마 유형:
-
인증 정보 위치는 보안 스키마 오브젝트 필드의 OpenAPI
문서에서읽습니다. -
auth 사용자 키는 보안 스키마 오브젝트의 OpenAPI 문서
이름필드에서 읽습니다.
다음은 apiKey 보안 요구 사항이 있는 OAS 3.0.2의 부분적인 예입니다.
OpenAPI 문서에서 보안 요구 사항을 지정하지 않으면 다음이 적용됩니다.
-
제품 인증은
apiKey용으로 구성됩니다. -
자격 증명 위치는 기본적으로
쿼리 매개변수(GET) 또는 본문 매개변수(POST/PUT/DELETE)로 3scale 값으로 설정됩니다. -
Auth 사용자 키는 기본적으로 3scale 값
user_key로 설정됩니다.
3scale 인증 보안은 OpenAPI CRD의 spec.privateAPIHostHeader 및 spec.privateAPISecretToken 필드를 사용하여 설정할 수 있습니다.
ActiveDocs
3scale ActiveDoc이 생성되지 않습니다.
3scale 제품 정책 체인
3scale 정책 체인은 기본 3scale이 생성하는 기본 정책 체인입니다.
3scale 배포 모드
기본적으로 구성된 3scale 배포 모드는 APIcast 3scale이 관리됩니다. 그러나 spec.productionPublicBaseURL 또는 spec.stagingPublicBaseURL 이나 두 필드가 OpenAPI CR에 있는 경우 제품의 배포 모드는 APIcast 자체 관리입니다.
사용자 지정 공용 기본 URL이 있는 OpenAPI CR의 예:
8.6.4. URL에서 OAS 문서를 가져오는 3scale OpenAPI 사용자 정의 리소스 배포 링크 복사링크가 클립보드에 복사되었습니다!
지정한 URL에서 OAS 문서를 가져오는 OpenAPI 사용자 정의 리소스를 배포할 수 있습니다. 그런 다음 이 OAS 문서를 개발자 포털에서 API용 ActiveDocs의 기반으로 사용할 수 있습니다.
사전 요구 사항
동일한 네임스페이스에 있는 3scale 인스턴스의 기본 테넌트에 연결되지 않는
사용자 정의 리소스를 생성하는 경우 OpenAPI CR이 포함된 네임스페이스에는OpenAPIOpenAPICR이 연결되는 테넌트를 식별하는 시크릿이 포함되어 있습니다. 시크릿 이름은 다음 중 하나입니다.-
threescale-provider-account - 사용자 정의
이 시크릿에는 3scale 인스턴스의 URL과 해당 3scale 인스턴스에서 하나의 테넌트에 대한 액세스 자격 증명이 포함된 토큰이 포함되어 있습니다.
-
절차
- OpenShift 계정에서 Operator > 설치된 Operator로 이동합니다.
- 3scale Operator를 클릭합니다.
- YAML 탭을 선택합니다.
OpenAPI사용자 정의 리소스를 생성합니다. 예를 들어 다음과 같습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
저장을 클릭합니다. 3scale Operator가
OpenAPICR을 생성하는 데 몇 초가 걸립니다.
검증
-
OpenShift의 3scale 제품 개요 페이지에서 동기화된 조건이
True로 표시되는지 확인합니다. - 3scale 계정으로 이동합니다.
-
OAS 문서가 있는지 확인합니다. 위의 예제에서는
openapi1이라는 새로운 OAS 문서가 표시됩니다.