클라이언트 라이브러리 빌드

Google API 탐색 서비스를 사용하여 Google API와 함께 사용할 다양한 도구를 빌드할 수 있습니다. 하지만 탐색 문서의 주요 목적은 Google에서 다양한 프로그래밍 언어로 클라이언트 라이브러리를 만들 수 있도록 하는 것입니다. 이 문서에서는 Google API용 커스텀 클라이언트 라이브러리를 빌드하는 방법을 설명합니다.

안정적이고 모든 기능을 갖춘 클라이언트 라이브러리는 개발하는 데 몇 개월이 걸릴 수 있는 복잡한 도구입니다. 그러나 간단한 Google API용 클라이언트 라이브러리를 빌드하는 일반적인 지침은 세 가지 간단한 단계로 나눌 수 있습니다.

  1. 탐색 문서 가져오기 및 API 노출 영역 생성
  2. 요청 작성
  3. 호출하고 응답 가져오기

이러한 단계에 대해서는 다음 섹션에서 더 자세히 설명합니다. 예시 섹션의 간단한 API 클라이언트 샘플에서 이러한 안내가 코드에 어떻게 매핑되는지 확인할 수도 있습니다.

탐색 문서 가져오기

클라이언트 라이브러리를 구현하기 전에 개발 경로를 진행하는 방법에 영향을 미치는 몇 가지 기본 요구사항이 있습니다. 예를 들어 원하는 프로그래밍 언어가 입력되거나 입력되지 않을 수 있습니다. 유형이면 정적 또는 동적 유형일 수 있습니다. 컴파일되거나 해석될 수 있습니다. 이러한 요구사항은 탐색 문서를 사용하고 소비하는 방법을 안내합니다.

첫 번째 개발 작업은 탐색 문서를 가져오는 것입니다. 문서를 가져올 정확한 시점은 식별된 요구사항에 따라 결정됩니다. 예를 들어 정적 유형의 언어에서는 프로세스 초기에 탐색 문서를 가져온 후 탐색 문서에 기술된 특정 API를 처리하는 코드를 생성할 수 있습니다. 강력하게 유형화된 언어의 경우 일부 코드를 생성하고 컴파일된 라이브러리를 빌드할 수 있습니다. 동적 유형 언어의 경우 프로그래밍 노출 영역이 사용되는 즉시 API와 상호작용하는 프로그래밍 구조를 느리게 구성할 수 있습니다.

요청 작성

요청 작성에는 두 가지 개별 단계가 포함됩니다.

  1. 요청 본문 작성
  2. 요청 URL 구성

요청 본문(있는 경우)을 언어에 적합한 표현에서 올바른 전송 형식으로 변환해야 합니다. 예를 들어 Java 클라이언트 라이브러리에는 요청 데이터의 유형 안전 조작을 허용하고 JSON으로 직렬화할 수 있는 각 요청 유형의 클래스가 있을 수 있습니다.

요청 URL 구성은 약간 더 복잡한 프로세스입니다.

API에서 각 메서드의 path 속성은 URI 템플릿 v04 구문을 사용합니다. 이 속성에는 중괄호로 묶인 변수가 포함될 수 있습니다. 다음은 변수가 포함된 path 속성의 예시입니다. 

/example/path/var

위 경로에서 var는 변수입니다. 이 변수의 값은 해당 메서드에 대한 탐색 문서의 parameters 섹션에서 가져옵니다. 각 변수 이름에는 parameters 객체의 해당 값이 있습니다. 위 예시에서는 parameters 섹션에 var라는 매개변수가 있습니다. 해당 location 속성은 경로 변수임을 나타내기 위해 path입니다.

요청을 수행할 때 URL에서 var 값을 대체해야 합니다. 예를 들어 라이브러리 사용자가 var를 foo 값으로 설정하도록 선택하면 새 URL은 /example/path/foo가 됩니다.

또한 path 속성은 상대 URI입니다. 절대 URI를 계산하려면 다음 단계를 따르세요.

  1. 위치(리전)를 알고 있고 탐색 문서에 endpoints 속성이 있는 경우 위치가 endpoints 목록에 있는지 확인합니다. 그렇다면 location이 내 위치와 일치하는 endpoints 목록에서 endpointUrl을 가져옵니다.

  2. 탐색 문서에 endpoints 속성이 없거나 위치가 endpoints 목록에 없거나 전역 엔드포인트를 타겟팅하려면 탐색 문서의 최상위 수준에서 rootUrl 속성을 가져옵니다.

    예를 들어 Service Usage API에 대한 탐색 문서의 rootUrl 속성은 다음과 같습니다. 

    https://serviceusage.s3nsapis.fr/
  3. 탐색 문서의 최상위 수준에서 servicePath를 가져옵니다. 예를 들어 Service Usage API의 탐색 문서에 있는 servicePath 속성은 비어 있습니다.

  4. 이를 함께 연결하여 다음을 얻을 수 있습니다.

    https://serviceusage.s3nsapis.fr/

  5. path 속성을 가져와서 URI 템플릿으로 확장하고 확장 결과를 이전 단계의 URI와 결합합니다. 예를 들어 v1 Service Usage API의 serviceusage.services.enable 메서드에서 path 속성 값은 v1/{+name}:enable입니다. 따라서 이 메서드의 전체 URI는 다음과 같습니다. 

    https://serviceusage.s3nsapis.fr/v1/{+name}:enable

Service Usage API를 호출하는 데 API 키가 필요하지 않습니다. 그러나 호출하는 API에 API 키가 필요한 경우 다음과 같이 URI의 쿼리 문자열에 API 키를 추가할 수 있습니다. 

REQUEST_URI?key=API_KEY

호출하기 및 응답 처리

요청을 보낸 후에는 응답을 적절한 언어 표현으로 역직렬화해야 하며, 기본 HTTP 전송과 API 서비스에서 생성된 오류 메시지 모두에서 발생할 수 있는 오류 조건을 처리해야 합니다. 오류 형식은 Google JSON 스타일 가이드의 일부에 설명되어 있습니다.

예시

다음 섹션에서는 API 클라이언트 라이브러리의 간단한 예시를 보여줍니다.

간단한 API 클라이언트

다음은 Python3로 작성된 매우 간단한 클라이언트 라이브러리의 예시입니다. 클라이언트는 Service Usage API와 상호작용하기 위한 인터페이스를 빌드한 후 이 인터페이스를 사용하여 my-project 프로젝트에서 Compute Engine API(compute.googleapis.com)를 사용 설정합니다. 

import httplib2
import json
import uritemplate
import urllib

# Step 1: Fetch Discovery document
DISCOVERY_URI = "https://serviceusage.s3nsapis.fr/$discovery/rest?version=v1"
h = httplib2.Http()
resp, content = h.request(DISCOVERY_URI)
discovery = json.loads(content)
location = None # Set this to your location if appropriate
use_global_endpoint = True # Set this to False if you want to target the endpoint for your location

# Step 2.a: Construct base URI
BASE_URL = None
if not use_global_endpoint and location:
  if discovery['endpoints']:
    BASE_URL = next((item['endpointUrl'] for item in discovery['endpoints'] if item['location'] == location), None)
if not BASE_URL:
  BASE_URL = discovery['rootUrl']
BASE_URL += discovery['servicePath']

class Collection(object): pass

def createNewMethod(name, method):
  # Step 2.b Compose request
  def newMethod(**kwargs):
    body = kwargs.pop('body', None)
    url = urllib.parse.urljoin(BASE_URL, uritemplate.expand(method['path'], kwargs))
    for pname, pconfig in method.get('parameters', {}).items():
      if pconfig['location'] == 'path' and pname in kwargs:
        del kwargs[pname]
    if kwargs:
      url = url + '?' + urllib.parse.urlencode(kwargs)
    return h.request(url, method=method['httpMethod'], body=body,
                     headers={'content-type': 'application/json'})

  return newMethod

# Step 3.a: Build client surface
def build(discovery, collection):
  for name, resource in discovery.get('resources', {}).items():
    setattr(collection, name, build(resource, Collection()))
  for name, method in discovery.get('methods', {}).items():
    setattr(collection, name, createNewMethod(name, method))
  return collection

# Step 3.b: Use the client
service = build(discovery, Collection())
print (serviceusage.services.enable(name='projects/my-project/services/compute.googleapis.com'))

클라이언트의 주요 구성요소는 다음과 같습니다.

  • 1단계: 탐색 문서를 가져옵니다. Service Usage API의 탐색 문서가 검색되어 데이터 구조로 파싱됩니다. Python은 동적 유형이 지정된 언어이므로 런타임 시 탐색 문서를 가져올 수 있습니다.
  • 2.a단계: 기본 URI를 구성합니다. 기본 URI가 계산됩니다.
  • 2.b단계: 요청을 작성합니다. 컬렉션에서 메서드가 호출되면 URI 템플릿이 메서드에 전달된 매개변수로 확장되고 위치가 query인 매개변수는 URL의 쿼리 매개변수에 배치됩니다. 마지막으로 탐색 문서에 지정된 HTTP 메서드를 사용하여 작성된 URL로 요청이 전송됩니다.
  • 3.a단계: 클라이언트 노출 영역을 빌드합니다. 클라이언트 노출 영역은 파싱된 탐색 문서를 재귀적으로 내림차순으로 빌드됩니다. methods 섹션의 각 메서드에 대해 새 메서드가 Collection 객체에 연결됩니다. 컬렉션이 중첩될 수 있으므로 resources를 찾고 리소스가 있으면 모든 멤버에 대해 Collection 객체를 재귀적으로 빌드합니다 각 중첩된 컬렉션은 Collection 객체에 속성으로도 연결됩니다.
  • 3.b단계: 클라이언트를 사용합니다. 이는 빌드된 API 노출 영역이 사용되는 방법을 보여줍니다. 먼저 탐색 문서에서 서비스 객체를 빌드한 후 Service Usage API를 사용하여 my-project 프로젝트에서 Compute Engine API를 사용 설정합니다.