9장. API 정의 (Methods and Metrics)
API 제품 및 백엔드 수준 모두에서 메서드 및 지표를 추가하여 API를 정의할 수 있습니다. API 제품은 하나 이상의 API 백엔드가 번들로 제공됩니다. 제품 수준에서 방법 및 메트릭을 사용하면 모든 제품의 애플리케이션 계획에 대한 제한 및 가격 규칙을 설정할 수 있습니다. 백엔드 수준에서 방법 및 메트릭을 사용하여 백엔드를 번들하는 모든 제품의 애플리케이션 계획의 제한 및 가격 규칙을 설정할 수 있습니다.
지표 는 제품 및 백엔드 수준 모두에서 API의 사용량을 추적하는 데 적합합니다. 히트 는 각 API에 존재하는 기본 제공 메트릭이며 API의 히트를 추적하는 데 사용됩니다. Hits 메트릭에서 방법을 정의하여 API 사용 추적을 더 세분하게 수행할 수 있습니다. 메서드로 트래픽을 보고하면 메서드 및 Hits 메트릭에 대한 카운터가 자동으로 증가합니다. API 백엔드의 각 끝점 또는 끝점 및 HTTP 메서드의 조합을 정의할 수 있습니다. API의 끝점을 여기에 정의된 메서드에 매핑하는 방법은 매핑 규칙 섹션을 참조하십시오.
히트와 별도로 API 사용을 측정하기 위해 새 메트릭을 정의하고 다른 단위로 사용량을 보고할 수 있습니다. 단위는 quantifiable이어야 하며 메가바이트, CPU 시간, API에서 반환된 요소 수 등과 같은 비즈니스 목표에 대한 의미를 적용해야 합니다. CPU 시간 또는 mb 와 같은 히트 이외의 모든 메트릭은 기본적으로 3scale에 포함되지 않으며 사용자가 구성한 외부 서비스에서 주기적으로 호출한 끝점을 사용하여 보고해야 합니다.
메서드 및 메트릭도 API를 패키징하는 스캐폴딩입니다. 각 애플리케이션 계획을 사용하면 각 메서드 및 메트릭에 대해 다양한 사용 제한 및 가격 규칙을 정의할 수 있습니다. 지표 및 방법에 보고된 사용량에 대한 자세한 내용은 API 분석 섹션을 참조하십시오.
추가 리소스
API 제품 및 백엔드에 대한 자세한 내용은 3scale 시작하기를 참조하십시오.
9.1. 방법 및 메트릭 추가
제품 또는 백엔드에 새 방법을 추가하려면 다음 단계를 따르십시오.
- [gradle_product_name] > 통합 > 방법 및 지표 또는 [your_backend_name] > 방법 및 지표 로 이동합니다.
- 메서드 목록 오른쪽 위에 있는 새 메서드 링크를 클릭합니다.
매개변수를 지정합니다.
- 친숙한 이름은 방법에 대한 간단한 설명이며 3scale 관리 포털의 다른 섹션에 표시됩니다. 이 이름은 제품에 고유해야 합니다.
-
시스템 이름은 3scale Service Management API를 통해 사용량을 보고하는 데 사용할 메서드의 이름입니다. 또한 고유해야 하며 영숫자 문자, 밑줄
_, 하이픈-및 슬래시/앞에 공백만 포함해야 합니다. 그 외에는 시스템 이름이 어떻게 보일지 자유롭게 결정할 수 있습니다. 엔드포인트 (/status)와 정확히 동일하거나, 예를 들어 메서드와 경로(GET_/status)를 포함할 수 있습니다. Description 필드는 메서드에 대한 자세한 설명에 사용할 수 있으며 선택 사항입니다.
- 마지막으로 Create Method 를 클릭합니다.
나중에 메서드 정의를 변경할 수 있습니다. 메서드 이름(메서드 )을 클릭하고 필드를 업데이트하고 Update Method를 클릭합니다.
방법 및 메트릭의 시스템 이름 변경 또는 삭제에 매우 주의하십시오. 이러한 변경으로 인해 메서드의 이전 시스템 이름을 가리키는 매핑 규칙이 있는 경우 이미 배포된 3scale 통합을 중단할 수 있습니다.
새 지표를 생성하려면 New 지표 를 클릭하고 필요한 매개변수를 제공합니다. 단위를 지정할 때 단일 noun (예: "hit")을 사용합니다. analytics 차트에서 자동으로 복수형이기 때문입니다.
이러한 새로운 방법과 메트릭은 현재 및 향후의 모든 계획에서 사용할 수 있습니다. 이제 [gradle _product_name] > 애플리케이션 > 애플리케이션 계획 > [plan_you_want_to_edit]로 이동하여 각 계획에서 제한 및 가격 규칙을 편집할 수 있습니다.
