5.8. OpenAPI 정의에서 3scale 백엔드 가져오기
toolbox import
명령을 사용하여 OpenAPI 정의를 가져오고 3scale backend API를 생성할 수 있습니다. 명령줄 옵션 --backend
에서 이 기능을 활성화합니다. 3scale은 OpenAPI 정의를 사용하여 백엔드와 해당 프라이빗 기본 URL과 매핑 규칙 및 메서드를 생성 및 저장합니다.
사전 요구 사항
- 3scale 2.13 On-Premises 인스턴스에 대한 관리자 권한이 있는 사용자 계정입니다.
- API를 정의하는 OAS 문서입니다.
절차
다음 형식을 사용하여
가져오기
명령을 실행하여 백엔드를 생성합니다.$ 3scale import openapi -d <remote> --backend <OAS>
-
&
lt;remote
>를 백엔드를 생성할 3scale 인스턴스의 URL로 바꿉니다. 이 형식 사용http[s]://<authentication>@3scale_domain
&
lt;OAS&
gt;를/path/to/your/oasdoc.yaml
로 바꿉니다.표 5.1. 추가 OpenAPI 정의 옵션 옵션 설명 -o --output=<value>
출력 형식입니다. JSON 또는 YAML일 수 있습니다.
--override-private-base-url=<value>
3scale은 OpenAPI 정의의
servers[0].url
필드에서 백엔드의 개인 엔드포인트를 읽습니다. 해당 필드에서 설정을 재정의하려면 이 옵션을 지정하고 <value
>를 선택한 개인 기본 URL로 바꿉니다. OpenAPI 정의가servers[0].url
필드에 값을 지정하지 않고import
명령에 이 옵션을 지정하지 않으면 실행에 실패합니다.--prefix-matching
OpenAPI 작업에서 파생된 매핑 규칙에 엄격한 일치 항목 대신 접두사 일치를 사용합니다.
--skip-openapi-validation
OpenAPI 스키마 검증을 건너뜁니다.
-t --target_system_name=<value>
대상 시스템 이름은 테넌트의 고유한 키입니다. OpenAPI 정의에서 시스템 이름을 유추할 수 있지만 이 매개 변수를 사용하여 고유한 이름으로 해당 이름을 재정의할 수 있습니다.