종속 항목 소개

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

API 허브 종속 항목을 사용하면 API 작업 간의 관계를 보고 관리할 수 있습니다. API의 종속 항목을 찾고 추적하면 API 생태계를 보다 효율적으로 관리하는 데 도움이 됩니다. 예를 들어 종속 항목을 사용하면 API 변경 또는 지원 중단으로 인한 잠재적 영향을 알아내거나, 문제를 해결하거나, 비용 또는 규정 준수 규제를 분석할 수 있습니다. API는 API 허브 내에 저장하거나 API 허브 외부에 저장할 수 있습니다.

종속 항목이란 무엇인가요?

API 허브는 종속 항목을 API 작업 간의 방향 관계로 모델링합니다. 여기서 API 작업 하나는 공급업체이고 다른 하나는 소비자입니다. 예를 들어 PetStore API가 Location API에서 작업을 호출한다고 가정해 보겠습니다. 이 경우 PetStore API는 Location API에서 제공하는 작업에 종속됩니다. API 허브에서는 PetStore를 소비자로, 위치를 공급업체로 지칭합니다.

그림 1은 API 작업 간의 공급업체/소비자 관계를 보여줍니다. Payment API의 /debit 작업은 Fraud Detection API의 /detect 작업을 사용합니다. 인출 작업은 이 관계의 소비자이고 사기 감지 작업은 이 관계의 공급업체입니다.

마찬가지로 /detect는 UserProfile API 및 GeoLocation API에서 제공하는 작업을 사용합니다. 이 경우 /detect 작업은 소비자이고 나머지 두 작업은 공급업체입니다.

API 허브 종속 항목

그림 1. API 종속 항목 매핑

종속 항목 만들기

업로드된 API 사양 또는 외부 API에서 API 허브에 추가된 API 작업 간에 종속 항목을 만들 수 있습니다.

API 허브에서 종속 항목을 만드는 기본 단계는 다음과 같습니다.

종속될 수 있는 작업이 있을 수 있는 두 개의 API를 찾습니다. 작업은 등록된 API 또는 외부 API에 있을 수 있습니다.
공급업체 작업과 소비자 API를 확인합니다. 앞에서 설명한 것처럼 소비자가 공급업체를 호출합니다.
Create Dependency API를 사용하여 공급업체와 소비자 간 종속 항목을 만듭니다.

Create Dependency API 호출에 대한 자세한 내용과 예시는 Create Dependency API를 참조하세요.

종속 항목 찾기

List Dependency API는 API 허브에서 종속 항목을 찾는 효과적인 방법입니다. API를 사용하면 consumer.operation_resource_name, consumer.external_api_resource_name, supplier.operation_resource_name, supplier.external_api_resource_name 필드를 필터링할 수 있습니다.

종속 항목을 찾는 기본 단계는 다음과 같습니다.

List Dependency API를 사용하여 모든 종속 항목을 나열하거나 API의 필터 기능을 사용하여 검색 범위를 좁힙니다.
List Dependency API를 사용하여 손상된 종속 항목을 상세히 살펴보고 공급업체 이름과 같은 세부정보를 자세히 탐색합니다.

다음은 종속 항목을 나열하는 API 호출의 예시입니다.

curl "https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/dependencies"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

손상된 종속 항목 식별

손상된 종속 항목을 식별하려면 다음 기본 단계를 따르세요.

List Dependency API를 사용하여 모든 종속 항목을 나열하거나 API의 필터 기능을 사용하여 검색 범위를 좁힙니다.
반환된 종속 항목 중 오류 플래그가 설정된 종속 항목을 식별합니다.

List Dependency API를 사용하여 손상된 종속 항목을 상세히 살펴보고 공급업체 이름과 같은 세부정보를 자세히 탐색합니다.

다음은 샘플 응답입니다. 여기서 오류 조건은 공급업체 작업이 삭제되었음을 나타냅니다.

{
  "name": "projects/common-dev-15/locations/us-central1/dependencies/user-to-pet",
  "consumer": {
      "displayName": "POST - /v2/user",
      "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/createuser"
  },
  "supplier": {
      "displayName": "POST - /v2/pet",
      "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/addpet"
  },
  "state": "VALIDATED",
  "description": "Dependency from user to pet API",
  "discoveryMode": "MANUAL",
  "createTime": "2024-04-17T19:33:31.215978712Z",
  "updateTime": "2024-04-17T19:33:31.737505297Z",
  {
    "error": "SUPPLIER_NOT_FOUND",
    "errorTime": 2024-05-18T20:23:42.465324Z
  }
}

기타 종속 항목 작업

종속 항목을 만든 후 API 허브 API를 사용하여 종속 항목의 세부정보를 가져오고, API 허브의 모든 종속 항목 목록을 필터링하여 종속 항목을 찾고, 종속 항목을 삭제하고, 종속 항목 설명을 업데이트할 수 있습니다. 모든 Dependency API는 API 참조 및 종속 항목 관리에 자세히 설명되어 있습니다.