Admin API 작업은 REST HTTP 동사에 직접 매핑됩니다. 이는 표준 HTTP 메소드를 사용하여 리소스를 검색하고 조작할 수 있음을 의미합니다.
Admin API URI의 구체적인 형식은 다음과 같습니다.
https://appengine.googleapis.com/v1/resourcePath?parameters
예를 들어 my-app
프로젝트에 있는 애플리케이션의 my-
frontend
서비스에서 my-v1
버전에 대한 모든 세부정보를 나열하려면 ?view=FULL
매개변수를 사용하여 HTTP 요청을 전송합니다.
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
API에서 지원되는 각 작업에 사용되는 전체 URI 집합을 보려면 App Engine Admin API 참조 문서를 참조하세요.
기본사항 알아보기
REST API를 처음 접하시나요? 시작하는 데 도움이 되는 몇 가지 리소스가 있습니다.
REST 기본사항
API를 호출하는 방법에는 2가지가 있습니다.
- HTTP 요청 전송 및 응답 파싱
- 클라이언트 라이브러리 사용
클라이언트 라이브러리를 사용하지 않으려는 경우에는 REST의 기본사항을 이해해야 합니다.
REST는 데이터 요청 및 수정에 대한 간편하고 일관성 있는 접근 방식을 제공하는 소프트웨어 아키텍처 스타일입니다.
REST는 'Representational State Transfer'의 줄임말로, Google API의 맥락에서 REST는 HTTP 동사를 사용하여 Google이 저장한 데이터 표현을 검색 및 수정하는 방법을 의미합니다.
RESTful 시스템에서는 리소스가 데이터 스토어에 저장되고, 클라이언트는 서버에서 특정 작업(리소스 생성, 검색, 업데이트, 삭제 등)을 수행하라는 요청을 전송하며, 서버는 작업을 수행하고 응답을 전송합니다. 이 응답은 지정된 리소스 표현의 형식을 취하는 경우가 많습니다.
Google의 RESTful API에서는 클라이언트가 POST
, GET
, PUT
또는 DELETE
등의 HTTP 동사를 사용하여 작업을 지정합니다. 다음과 같은 형식의 전역적으로 고유한 URI를 사용하여 리소스를 지정합니다.
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
모든 API 리소스에는 HTTP에서 액세스할 수 있는 고유 URI가 있으므로 REST는 데이터 캐싱을 지원하며 웹의 분산형 인프라와의 연동성이 뛰어납니다.
HTTP 1.1 표준 문서의 메서드 정의를 확인하면 유용합니다. 문서에 GET
, POST
, PUT
, DELETE
의 사양이 포함되어 있습니다.
JSON 기본사항
Admin API는 JSON 형식으로 데이터를 반환합니다.
JSON(JavaScript Object Notation)은 특정 언어에 의존하지 않는 일반적인 데이터 형식으로, 임의의 데이터 구조를 간단한 텍스트로 표현할 수 있습니다. 자세한 내용은 json.org를 참조하세요.