예 작성

온라인에서 편집하기

예를 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 ConnectAI Gateway 의 OpenAPI 3.0 지원의 내용을 참조하십시오.

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

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

프로시저

예를 작성하십시오. 처음부터 예를 작성하거나 예 컴포넌트에서 정의된 예를 참조할 수 있습니다.
- 처음부터 예를 작성하려면 정의 탭에 다음 정보를 제공하십시오.
  - 예 이름: 예 컴포넌트를 편집하는 경우, 이 이름은 이 예가 API 정의의 다른 곳으로부터 참조할 수 있게 하는 키를 정의합니다. 참조의 형식은 다음과 같습니다.
```
#/components/examples/Name
```
  - 요약: 예에 대한 요약 설명입니다.
  - 설명: 예제에 대한 전체 설명입니다. 서식 있는 텍스트를 표현하려면 CommonMark 구문을 사용할 수 있습니다.
  - 외부 값: 리터럴 예를 가리키는 URL입니다. 쉽게 JSON 또는 YAML 문서에 포함될 수 없는 예를 참조하는 기능을 제공합니다. 예를 들어, PDF일 수 있습니다.
- 예 컴포넌트에서 정의된 예를 참조하려면 참조 탭에 다음 정보를 제공하십시오.
  - 예 이름: 예 컴포넌트를 편집하는 경우, 이 이름은 이 예가 API 정의의 다른 곳으로부터 참조할 수 있게 하는 키를 정의합니다. 참조의 형식은 다음과 같습니다.
```
#/components/examples/Name
```
  - 다음에서 참조: 예 컴포넌트에 대한 참조를 선택하십시오.
작성을 클릭하십시오.
예제의 세부 내용이 표시되어 추가 편집이 가능합니다. ‘예제 편집’을 참조하십시오.