API에 OpenAPI 확장 추가

온라인에서 편집하기

API에 JSON 또는 YAML 확장 스키마를 추가하여 OpenAPI 스펙을 확장할 수 있습니다. OpenAPI 확장은 카탈로그 또는 카탈로그 내의 공간으로 가져온 후 API 스키마에 추가됩니다.

시작하기 전에

OpenAPI 확장을 샌드박스 카탈로그 또는 확장을 추가하는 API가 공개될 카탈로그로 가져오십시오. OpenAPI 확장을 카탈로그로 가져오기를 참조하십시오.

이 태스크에 대한 정보

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

API Manager UI 전용: 이 태스크를 완료하려면 Api-Drafts:Edit 권한이 있는 역할이 지정되어야 합니다. 사전 제공된 개발자 역할에는 기본적으로 이 권한이 있습니다. 사용자 정의 역할이 지정된 경우 해당 역할에 이 권한이 있어야 합니다. 자세한 정보는 사용자 정의 역할 작성을 참조하십시오.

프로시저

  1. 탐색 창에서 클릭하세요 API UI 탐색 분할창의 개발 아이콘 [개발]을 클릭한 다음 [API] 탭을 선택하세요.
  2. 작업할 API의 제목을 클릭하십시오.
  3. 게이트웨이 탭을 선택하고 게이트웨이 및 포털 설정을 펼친 후 확장을 클릭하십시오.
  4. 이 API와 함께 사용할 OpenAPI 확장을 선택한 후 저장을 클릭하십시오.
    참고: 나열된 OpenAPI 확장 기능은 API의 테스트 기본 설정에 정의된 카탈로그 및 게이트웨이 서비스로 가져온 것들입니다. 자세한 내용은 ‘카탈로그에 OpenAPI 확장 기능 가져오기’ 및 ‘API의 테스트 기본 설정 지정’을 참조하십시오. 또한 OpenAPI 확장을 API가 공개될 카탈로그로 가져와야 합니다.
  5. 다음과 같이 선택한 OpenAPI 확장 스키마 파일에 정의된 필드의 값으로 API 정의에 대한 OpenAPI 소스를 업데이트하십시오.
    1. ‘소스’ 아이콘을 클릭하세요 OpenAPI 소스 아이콘.
    2. 이름이 x- 로 시작해야 하고 사용자가 작성한 OpenAPI 확장의 이름을 참조하는 특성을 추가하십시오. OpenAPI 확장 YAML 파일에 정의된 특성의 값을 지정하십시오.
      예를 보려면 “API 정의에서 확장 기능 참조하기”를 참조하십시오
    3. 완료되면 저장 을 클릭하십시오.