API 메타데이터는 API에 관한 요약 정보를 제공합니다. API 정의의 정보 섹션에 API 메타데이터를 입력합니다.
이 태스크에 대한 정보
참고: 이 태스크는 OpenAPI 2.0 API정의 구성과 관련됩니다. OpenAPI 3.0 API 정의를 구성하는 방법에 대한 세부사항은
OpenAPI 3.0 API 정의 편집을 참조하십시오.
API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.
언제든지 소스 아이콘을 클릭하면 기본
OpenAPI YAML 소스 파일로 바로 전환할 수 있습니다. 양식 화면으로 돌아가려면 양식 아이콘을 클릭하세요
.
- OpenAPI 2.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
- 일반 섹션을 펼친 후 정보를 클릭하십시오.
- 다음 정보를 제공하십시오.
- 제목(필수): API의 제목입니다.
- 이름: API가 작성되었고 변경될 수 없을 때 이름이 자동으로 작성되었습니다. 이름 필드의 값은 개발자 툴킷 CLI 명령에서 API를 식별하는 데 사용되는 단일 문자열입니다. 초안 API를 관리하는 CLI 명령어를 확인하려면 툴킷 CLI 참조 문서를 참조하십시오.
- 버전: API가 처음에 작성되고 그 후에 변경될 수 없을 때 API 버전이 지정됩니다. 하지만 기존 API의 새 버전을 생성할 수는 있습니다. 자세한 내용은 ‘API 정의의 새 버전 생성’을 참조하십시오.
- 설명: API에 대한 선택적 설명입니다. 서식 있는 텍스트를 표현하려면 CommonMark 구문을 사용할 수 있습니다.
- 서비스 약관: API에 대한 서비스 조건의 URL입니다.
- 컨택 이름: 컨택 개인/조직의 식별 이름입니다.
- 연락처 URL : 연락처 정보를 가리키는 URL.
- 연락처 이메일: 담당자/조직의 이메일 주소입니다.
- 라이센스 이름: API에 사용되는 라이센스 이름입니다.
- 라이선스 URL : API에 사용된 라이선스에 대한 URL 입니다.
- 완료되면 저장 을 클릭하십시오.