API 및 제품 정의에 대한 템플리트 변수

온라인에서 편집하기

OpenAPI 2.0 및 OpenAPI 3.0 API를 작성할 때와 제품 정의를 작성할 때 템플리트 파일을 사용할 수 있습니다. 템플리트 파일은 API 또는 제품 정의를 작성할 때 값으로 대체되는 {{variable-name}} 양식의 변수를 포함하는 Handlebars 템플리트입니다.

제품 정의 변수

다음 표에서는 제품 정의 파일에서 사용할 수 있는 Handlebars 템플리트 변수를 설명합니다. Handlebars에 대한 자세한 내용은 https://handlebarsjs.com/ 을 참조하십시오. 제품 정의 템플리트 파일에는.hbs 파일 이름 확장자.

표 1. 제품 정의 Handlebars 템플릿 변수
가변 유형 설명
{{apis}} 문자열의 배열 제품 정의가 참조하는 API입니다. 대체 후 배열 값은 apis.routes[n].$ref 필드의 값이 됩니다. 예를 들어, 다음과 같습니다.
apis:
  'routes':
    $ref: apidef.yaml
    ...
{{name}} 문자열 info.x-ibm-name 필드의 값입니다.
{{title}} 문자열 info.title 필드의 값입니다.
{{version}} 문자열 info.version 필드의 값입니다.

API 정의 변수

다음 표에서는 API 정의 파일에서 사용할 수 있는 Handlebars 템플리트 변수를 설명합니다. Handlebars에 대한 자세한 내용은 https://handlebarsjs.com/ 을 참조하십시오. API 정의 템플리트 파일에는.hbs 파일 이름 확장자.

표 2. API 정의: Handlebars 템플릿 변수
가변 유형 설명
{{basepath}} 문자열 API가 지원되는 기본 경로로, host에 상대적입니다.
{{definitions}} OpenAPI 정의 객체를 YAML 문자열로 변환한 것("stringified"). API에는 작업에서 소비하고 생성할 수 있는 데이터 유형이 포함되어 있습니다. 이러한 데이터 유형은 기본요소, 배열 또는 모델일 수 있습니다.
{{definitionsObj}} OpenAPI 정의 객체를 YAML 문자열로 변환한 것("stringified"). API에는 작업에서 소비하고 생성할 수 있는 데이터 유형이 포함되어 있습니다. 이러한 데이터 유형은 기본요소, 배열 또는 모델일 수 있습니다.
{{hostname}} 문자열 host 필드의 값입니다.
{{name}} 문자열 info.x-ibm-name 필드의 값입니다.
{{paths}} OpenAPI paths 객체 API에는 개별 엔드포인트에 대한 상대 경로가 포함되어 있습니다. 경로는 {{basePath}}에 추가되어 전체 URL을 구성합니다.
{{pathsObj}} OpenAPI paths 객체 API에는 개별 엔드포인트에 대한 상대 경로가 포함되어 있습니다. 경로는 {{basePath}}에 추가되어 전체 URL을 구성합니다.
{{schemes}} 문자열의 배열 API의 전송 프로토콜입니다. 값은 "http","https", "ws" 또는 "wss" 중 하나여야 합니다.
{{targeturl}} 문자열 x-ibm-configuration.assembly.execute[invoke]의 값입니다. 기본값은 $(runtime-url)$(request.path)입니다.
{{title}} 문자열 info.title 필드의 값입니다.
{{version}} 문자열 info.version 필드의 값입니다.