API 특성 설정

온라인에서 편집하기

API Connect 정책의 동작을 제어하는 데 사용할 수 있는 사전 제공된 API 특성 외에도 사용자 고유의 API 특성을 정의할 수 있습니다. 사용자가 정의하는 특성을 API 정의에서 참조할 수 있습니다.

이 태스크에 대한 정보

참고:

이 태스크는 OpenAPI 3.0 API 정의 구성과 관련이 있습니다. OpenAPI 2.0 API 정의를 구성하는 방법에 대한 세부사항은 OpenAPI 2.0 API 정의 편집을 참조하십시오.
OpenAPI 3.0 API는 DataPower Gateway (v5 compatible)가 아닌 DataPower® API Gateway에서만 지원됩니다.
현재 OpenAPI 3.0 지원 제한사항에 대한 세부사항은 IBM® API Connect 의 OpenAPI 3.0 지원의 내용을 참조하십시오.

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

API 특성에는 특성 이름, 값, 선택적으로 특성 값이 적용되는 특정 카탈로그가 포함됩니다. 다양한 정책과 관련된 기본 제공 API 속성 목록은 API 속성을 참조하십시오.

참고: 일단 정의되면 API 특성은 읽기 전용입니다.

API 정의에서 속성을 참조하는 방법에 대한 자세한 내용은. API Connect의 ‘변수 참조’를 참조하십시오.

카탈로그에 특정하고 해당 카탈로그의 API에서 참조할 수 있는 특성을 정의할 수도 있습니다. 자세한 정보는 카탈로그 작성 및 구성을 참조하십시오. API 특성과 동일한 이름의 카탈로그 특성을 정의하는 경우 API 특성이 카탈로그 특성보다 우선합니다.

언제든지 소스 아이콘을 클릭하면 기본 OpenAPI 소스 아이콘 OpenAPI YAML 소스 파일로 바로 전환할 수 있습니다. 양식 화면으로 돌아가려면 양식 아이콘을 클릭하세요 .

팁: 이미 스테이징되거나 공개된 API에서 API 특성을 추가하거나 변경하는 경우, 변경사항을 적용하려면 업데이트된 API를 포함하는 제품을 다시 스테이징하거나 다시 공개해야 합니다.

프로시저

OpenAPI 3.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
게이트웨이 탭을 선택하고 게이트웨이 및 포털 설정 을 펼친 후, 이미 하나 이상의 API 특성이 정의되어 있는 경우 특성을 펼치십시오.
API 특성을 구성하십시오.
- 새 API 특성을 정의하려면 다음 단계를 완료하십시오.
  1. 탐색 창에서 [속성] 옆의 추가 아이콘을 클릭하세요.
  2. 다음 정보를 제공하십시오.
    - 특성 이름: 특성의 이름을 입력하십시오. 이 이름은 특성을 참조하는 데 사용됩니다. API 특성의 이름에는 [A-Za-z0-9_-]+ 문자 세트가 지원됩니다. 공백이 허용됩니다.
    - 값: 특성의 기본값입니다. 특성이 기본적으로 널 값을 가지고 있는 경우 비워 두십시오.
    - 설명: 특성에 대한 선택적 설명입니다. 서식 있는 텍스트를 표현하려면 CommonMark 구문을 사용할 수 있습니다.
    - 특성 값을 숨기거나 사용자 비밀번호를 보호하려면 인코딩 선택란을 선택하십시오.
      참고: 특성 값을 인코딩하는 경우 Base64 인코딩 양식으로 저장됩니다. 암호화되지 않습니다 . 이후에 인코딩 선택란을 선택 취소하면 원래 특성 값이 인코딩되지 않은 양식으로 복원됩니다.
  3. 작성을 클릭하십시오.
- 기존 API 특성을 수정하려면 탐색 분할창에서 특성 이름을 클릭하십시오. 그런 다음 구성 설정을 변경할 수 있습니다.
저장을 클릭하여 변경사항을 저장하십시오.

다음에 수행할 작업

선택적으로 특정 카탈로그에 특정한 특성의 값을 정의하십시오. 카탈로그 특정 특성 값 정의를 참조하십시오.