소개

Discovery API는 각 API의 머신이 읽을 수 있는 '검색 문서' 메타데이터를 검색하기 위한 Google API 목록을 제공합니다.

이 문서는 클라이언트 라이브러리, IDE 플러그인, Google API와 상호작용하는 기타 도구를 작성하려는 개발자를 대상으로 합니다.

검색 서비스 배경

개념

Google API 검색 서비스는 두 가지 기본 개념을 기반으로 합니다.

  • API 디렉터리: API 검색 서비스에서 지원하는 모든 API의 목록입니다. 각 디렉터리 항목에는 이름, 기능에 대한 간단한 설명, 문서 링크 등 지원되는 API에 관한 세부정보가 표시됩니다. API에는 지원되는 버전별로 하나씩, 여러 개의 디렉터리 항목이 있을 수 있습니다.
  • 검색 문서: 컴퓨터가 읽을 수 있는 특정 API 설명입니다. 검색 문서에서는 특정 API 버전의 노출 영역을 설명합니다. 이 문서에서는 RESTful HTTP 호출을 통해 각 API의 다양한 메서드에 액세스하는 방법을 자세히 설명합니다. 검색 문서에는 API와 연결된 데이터 및 메서드 설명, 사용 가능한 OAuth 범위 정보, 스키마, 메서드, 매개변수, 사용 가능한 매개변수 값에 대한 설명이 포함되어 있습니다.

데이터 모델

리소스는 고유 식별자가 있는 개별 데이터 항목입니다. Google API 검색 서비스는 위의 개념을 바탕으로 두 가지 유형의 리소스에서 작동합니다.

API 디렉터리 목록: API 목록

각 디렉터리 항목에는 다음 정보가 포함된 API 이름/버전 쌍이 포함되어 있습니다.

  • ID 및 설명 정보: 이름, 버전, 제목, 설명
  • 문서 정보: 아이콘 및 문서 링크
  • 상태 정보(상태 라벨 및 API의 기본 버전인지 여부 표시)
  • 검색 문서 링크: 이 API의 검색 문서 URI(전체 URL로 지정)(예: https://servicemanagement.googleapis.com/$discovery/rest?version=v1)

검색 문서 리소스: 컴퓨터가 읽을 수 있는 특정 API 설명입니다.

API 디렉터리에 제공된 정보 외에도 검색 문서에는 다음 항목이 포함됩니다.

  • 스키마: 각 API에서 액세스할 수 있는 데이터를 설명하는 API 리소스 스키마 목록입니다. Google API 검색 서비스 스키마는 JSON 스키마를 기반으로 합니다.
  • 메서드: API 메서드 목록과 각 메서드에 사용할 수 있는 매개변수를 포함합니다.
  • OAuth 범위: 이 API에 사용할 수 있는 OAuth 범위 목록을 식별합니다.
  • 인라인 문서: 스키마, 메서드, 매개변수, 사용 가능한 매개변수 값에 대한 간략한 설명이 제공됩니다.

단일 디렉터리 컬렉션은 단일 API 디렉터리 리소스 및 지원되는 각 API의 검색 문서 리소스의 개념적 컨테이너입니다.

API 디렉터리 리소스 및 검색 문서 리소스에 대한 자세한 내용은 API 사용하기 및 참조 문서를 참고하세요.

운영

다음 표에 설명된 대로 Google API 검색 서비스의 컬렉션 및 리소스에서 두 가지 메서드를 호출할 수 있습니다.

작업 설명 REST HTTP 매핑
list 지원되는 모든 API를 나열합니다. 디렉터리 리소스 URI의 GET

통화 스타일

REST

지원되는 Google API 검색 서비스 작업은 작업에 설명된 대로 REST HTTP GET 동사에 직접 매핑됩니다.

Google API 검색 서비스 URI의 구체적인 형식은 다음과 같습니다.

https://discovery.googleapis.com/discovery/v1/apis?parameters

여기서 api은 검색 문서 리소스의 식별자이고 version는 API의 특정 버전 식별자이며 _parameters_은 쿼리에 적용되는 매개변수입니다. 자세한 내용은 참조 문서의 쿼리 매개변수 요약을 참조하세요.

API에서 지원되는 각 작업에 사용되는 전체 URI 세트에 대한 세부정보는 Google API 검색 서비스 참조 문서에 요약되어 있습니다.

다음은 Google API 검색 서비스에서 작동 원리의 몇 가지 예입니다.

Google API 검색 서비스에서 지원하는 모든 API를 나열합니다.

GET https://discovery.googleapis.com/discovery/v1/apis

API 탐색기에서 지금 사용해 보세요.

Google Cloud Service Management API 버전 1의 검색 문서를 가져옵니다.

GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1