이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.
API 페이지에서는 API에 대한 자세한 정보를 제공합니다. API 목록 페이지에서 API를 선택하면 API 페이지 개요 탭이 표시됩니다.
개요 탭에는 다음 섹션이 있습니다.
일반
일반 창에는 API에 대한 다음을 비롯한 최상위 정보가 표시됩니다.
- 표시 이름: API의 표시 이름입니다. API를 등록할 때 정의됩니다. 표시 이름을 수정하려면 API 등록 세부정보 수정을 참조하세요.
- 설명: API에 대한 설명입니다. API를 등록할 때 정의됩니다. 설명을 수정하려면 API 등록 세부정보 수정을 참조하세요.
- 시스템 및 커스텀 분류 요소
- 문서 버전: 현재 배포에 할당된 사양 버전을 여는 링크입니다. 이 버튼은 API에 권장 배포 집합이 있고 배포에 버전이 할당된 경우에만 표시됩니다.
- 액세스 권한 가져오기: 이 API에 액세스하는 방법에 대한 안내를 제공합니다. 이 안내를 수정하려면 배포 수정을 참조하세요. 이 버튼은 권장 배포 집합이 있는 경우에만 나타납니다.
알 수 없는 라벨 또는 태그가 공개 API를 통해 연결된 경우 UI에 표시되지 않습니다. 알려진 분류를 정의하는 라벨만 표시됩니다.
분류 값에 텍스트 설명 또는 URL을 할당할 수 있습니다. 이 창에서 분류 값에 텍스트 설명이 할당되면 마우스를 가져갈 때 설명이 표시되는 값 옆에 정보 아이콘이 표시됩니다. 값이 URL이면 표시된 분류 값이 새 브라우저 탭에서 URL을 여는 하이퍼링크가 됩니다. 자세한 내용은 분류 추가를 참조하세요.
API 수정
API 등록 세부정보 수정을 참조하세요.
API 삭제
Delete API를 참조하세요.
스코어카드
스코어카드는 팀에서 API 품질을 측정하는 방법을 이해하는 데 도움이 됩니다. API 포트폴리오 전반에서 신중한 스코어링 접근 방식을 취하면 설계 표준, 보안 프로필, 안정성 또는 비즈니스에 중요한 기타 측정기준과 같은 다양한 영역에서 일관성을 유지하는 데 도움이 될 수 있습니다. API 허브에는 OpenAPI 린트 작업이 이미 구성되어 있습니다.
스코어카드는 단일 수량으로 쉽게 줄일 수 없는 점수 그룹을 나타냅니다.
점수는 API 품질의 일부 측면을 나타내는 단일 값입니다. 품질은 모든 컨텍스트(디자인, 안정성, 규정 준수 등)에서 정의될 수 있으며 종종 의견이 다를 수 있습니다.
스코어카드 숨기기
모든 API의 스코어카드 UI를 숨기려면 API 스코어카드 중지 또는 사용 설정을 참조하세요.
스코어카드 버전 선택
이 사양의 점수 매기기 드롭다운 목록에서 스코어카드에 사용할 버전을 선택합니다.
각 항목의 의미는 다음과 같습니다.
- 최신: 이 사양 버전에는 최신 업로드 타임스탬프가 있습니다.
- 권장: 이 사양에는 권장 배포에 할당된 버전 중 하나가 있습니다. API 소비자라면 이 사양을 사용합니다.
스코어카드 맞춤설정
스코어카드를 맞춤설정하고 구성하려면 레지스트리 명령줄 도구를 사용합니다.
추가 정보: 점수는 어떻게 계산하나요?
스코어카드의 오류 및 경고 옆에 상태 아이콘을 표시하려면 임곗값을 정의하세요.
각 항목의 의미는 다음과 같습니다.
| 유형 | 아이콘 | 설명 |
|---|---|---|
| 알림 |  |
임곗값이 알림에 정의된 범위 내에 있으면 이 아이콘을 표시합니다. |
| 경고 |  |
임곗값이 경고에 정의된 범위 내에 있으면 이 아이콘을 표시합니다. |
| 확인 |  |
임계값이 확인에 정의된 범위 내에 있으면 이 아이콘을 표시합니다. |
린트 요약
API 허브 스코어카드 기본 구성은 API 허브에 업로드된 OpenAPI v2 및 OpenAPI v3 사양의 린트 경고 및 린트 오류를 보고합니다. API 허브 및 레지스트리에는 Spectral에 기반한 기본 린터가 포함됩니다. 이 린터는 일반적인 오류로 인한 노이즈를 줄이기 위해 사용 설정된 몇 가지 예외와 함께 OpenAPI Rules 규칙 세트를 사용하여 린트 기능의 참조 예제로 제공됩니다(Spectral 자체 지원에 대한 예상 제외). 커스텀 린터를 사용한 확장은 현재 지원되지 않습니다.
린터 구성 업데이트에 대한 지침은 레지스트리의 API 스타일 가이드를 참조하세요.
배포
배포 탭에는 API 편집기에서 구성한 API의 모든 배포가 표시됩니다. 배포는 API가 배포된 라이브 환경을 나타냅니다. 배포는 환경 이름에 따라 정렬(내림차순)됩니다. 다음 정보가 표시됩니다.
- 환경
- 문서
- 권장 배포 지표
- 게이트웨이
- 사용 안내
- 외부 채널
- 액세스하기
자세한 내용은 배포 관리를 참조하세요.
버전
버전 탭에는 API에 정의된 모든 버전이 표시됩니다. 버전은 버전 번호에 따라 정렬(내림차순)됩니다. 다음 정보가 표시됩니다.
- 버전
- 수명 주기 단계
- 최종 버전
- 지원 종료
자세한 내용은 버전 관리를 참조하세요.
관련 항목
API 개요 페이지 하단에 표시되는 관련 항목 창에서는 API와 관련된 기타 정보의 링크를 제공합니다. 예를 들어 구현 소스 코드, 설계 문서, 인프라 시스템이 여기에 해당됩니다. 자세한 내용은 관련 항목을 참조하세요.
종속 항목
API 개요 페이지 하단에 표시되는 종속 항목 창에는 다른 내부 API(API 허브에 있음), 외부 타사 API(API 허브에 없음) 및 기타 프로덕션 시스템을 포함하여 API의 모든 종속 항목이 나열됩니다. 예를 들어 데이터베이스 및 스토리지 솔루션이 이에 해당됩니다. 자세한 내용은 종속 항목을 참조하세요.
