11장. API 정의 (Methods and Metrics)
3scale에서 API를 정의하려면 [Remote_API_service] > Integration > Methods & Metrics 로 이동하여 메서드 및 지표를 추가합니다.
메트릭을 사용하면 3scale에서 API의 사용량을 추적할 수 있습니다. 히트 는 기본 제공 메트릭이며 각 API 서비스에 존재하며 API의 히트를 추적하는 데 사용됩니다. Hits 메트릭에서 방법을 정의하여 API 사용 추적을 더 세분하게 수행할 수 있습니다. 메서드로 트래픽을 보고하면 메서드 및 Hits 메트릭에 대한 카운터가 자동으로 증가합니다. API의 각 끝점 또는 끝점 및 HTTP 메서드의 조합을 정의할 수 있습니다. API의 끝점을 여기에 정의된 메서드에 매핑하는 방법은 규칙 매핑 섹션을 참조하십시오.
API의 적중 기반 사용이 아닌 다른 항목을 측정하기 위해 새 메트릭을 정의하고 다양한 단위로 사용량을 보고할 수 있습니다. 단위는 메가바이트, CPU 시간, API 등에 의해 반환되는 요소의 수 등 의미 있는 모든 것이 될 수 있습니다.
메서드 및 메트릭도 API를 패키징하기 위한 스캐폴딩입니다. 각 애플리케이션 계획을 사용하면 각 메서드 및 메트릭에 대해 다양한 사용 제한과 가격 규칙을 정의할 수 있습니다.
usage가 analytics 섹션의 메트릭 및 메서드에 보고된 것을 확인할 수 있습니다.
11.1. 방법 및 메트릭 수동 추가 링크 복사링크가 클립보드에 복사되었습니다!
[Remote_API_name] > 통합 > 방법 및 지표 로 이동합니다.
- 새 방법을 클릭합니다.
매개변수를 지정합니다.
- 친숙한 이름은 방법에 대한 간단한 설명이며 3scale 관리 포털의 다른 섹션에 표시됩니다. 이 이름은 서비스에 고유해야 합니다.
-
시스템 이름은 3scale Service Management API를 통해 사용량을 보고하는 데 사용할 메서드의 이름입니다. 또한 고유해야 하며 영숫자 문자, 밑줄
_
, 하이픈-
및 슬래시/
앞에 공백만 포함해야 합니다. 그 외에는 시스템 이름이 어떻게 보일지 자유롭게 결정할 수 있으며 엔드포인트("/status")와 정확히 동일하거나, 예를 들어 방법과 경로("GET_/status")를 포함할 수 있습니다. Description 필드는 메서드에 대한 자세한 설명에 사용할 수 있으며 선택 사항입니다.
- 마지막으로 Create Method 버튼을 클릭합니다.
나중에 메서드 정의를 변경할 수 있습니다. 메서드 이름(메서드 )을 클릭하고 필드를 업데이트하고 Update Method를 클릭합니다.
방법 및 메트릭의 시스템 이름 변경 또는 삭제에 매우 주의하십시오! 메서드의 이전 시스템 이름에 대한 매핑 규칙이 있는 경우 이미 배포된 3scale 통합을 중단할 수 있습니다.
새 지표를 생성하려면 New 지표를 클릭하고 필요한 매개변수를 제공합니다. 단위를 지정할 때 withoutular noun (e.g. "hit")을 사용합니다. as it will be pluralized automatically in the analytics charts.
이러한 새로운 방법과 메트릭은 현재 및 향후의 모든 계획에서 사용할 수 있습니다. 이제 각 계획에서 제한 및 가격 규칙을 편집할 수 있습니다. [gradle_API_service] > 애플리케이션 > 애플리케이션 계획 > [plan_you_want_to_edit].