8.6. 3scale OpenAPI 사용자 정의 리소스 배포
OpenAPI CR(사용자 정의 리소스)은 개발자 포털의 ActiveDocs에 사용할 수 있는 OAS(OpenAPI 사양) 문서를 가져오는 한 가지 방법입니다. OAS는 API에 특정 프로그래밍 언어를 사용하지 않는 표준입니다. 사용자와 컴퓨터는 소스 코드 액세스, 문서 또는 네트워크 트래픽 검사 없이 API 제품의 기능을 더 쉽게 이해할 수 있습니다.
사전 요구 사항
- 3scale 2saas On-Premises 인스턴스에 대한 관리자 권한이 있는 사용자 계정입니다.
- API를 정의하는 OAS 문서입니다.
-
OpenAPICR을 테넌트에 연결하는 방법에 대한 이해.
8.6.1. 시크릿에서 OAS 문서를 가져오는 3scale OpenAPI 사용자 정의 리소스 배포 링크 복사링크가 클립보드에 복사되었습니다!
3scale 백엔드 및 제품을 만들 수 있도록 OpenAPI CR(사용자 정의 리소스)을 배포합니다.
운영자는 시크릿의 콘텐츠만 읽습니다. Operator는 시크릿에서 필드 이름을 읽지 않습니다.
사전 요구 사항
OpenAPI CRD를 포함할 네임스페이스에는
OpenAPICRD가연결되는테넌트를 식별하는 보안이 포함되어 있습니다. 보안 이름은 다음 중 하나입니다.-
threescale-provider-account - 사용자 정의
이 시크릿에는 3scale SaaS의 URL과 해당 3scale SaaS의 테넌트에 액세스하기 위한 인증 정보가 포함된 토큰이 포함되어 있습니다.
-
절차
OAS 문서가 포함된 시크릿을 정의합니다. 예를 들어 이 콘텐츠를 사용하여
myoasdoc1.yaml을 생성할 수 있습니다.openapi: "3.0.2" info: title: "some title" description: "some description" version: "1.0.0" paths: /pet: get: operationId: "getPet" responses: 405: description: "invalid input"시크릿을 생성합니다. 예를 들면 다음과 같습니다.
$ oc create secret generic myoasdoc1 --from-file myoasdoc1.yaml secret/myoasdoc1 createdOpenAPICR을 정의합니다. OAS 문서가 포함된 보안에 대한 참조를 지정해야 합니다. 예를 들어myopenapicr1.yaml 파일을 생성할 수 있습니다.apiVersion: capabilities.3scale.net/v1beta1 kind: OpenAPI metadata: name: myopenapicr1 spec: openapiRef: secretRef: name: myoasdoc1방금 정의한 리소스를 생성합니다. 예를 들면 다음과 같습니다.
$ oc create -f myopenapicr1.yaml주어진 예에서 출력은 다음과 같습니다.
openapi.capabilities.3scale.net/myopenapicr1 created