오퍼레이션을 위한 외부 문서 지정

온라인에서 편집하기

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를 사용하여 이 태스크를 완료할 수 있습니다.

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

프로시저

  1. OpenAPI 3.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
  2. 경로를 펼친 후 필요한 경로를 펼치십시오.
  3. 조작을 펼치고 필요한 조작을 펼친 후 외부 문서를 클릭하십시오.
  4. 다음 정보를 제공하십시오.
    • URL(필수): 목표 문서를 위한 URL입니다.
    • 설명: 목표 문서에 대한 선택적 설명입니다. 서식 있는 텍스트를 표현하려면 CommonMark 구문을 사용할 수 있습니다.
  5. 완료되면 저장 을 클릭하십시오.