A API Discovery fornece uma lista de APIs do Google para recuperar metadados do "documento de descoberta" legível por máquina para cada API.
Este documento é destinado a desenvolvedores que querem criar bibliotecas de cliente, plug-ins de ambiente de desenvolvimento integrado e outras ferramentas para interagir com as APIs do Google.
Base do serviço de descoberta
Conceitos
O serviço de descoberta de APIs do Google foi criado sob dois conceitos básicos:
- Diretório de APIs: uma lista de todas as APIs compatíveis com o serviço de descoberta de APIs. Cada entrada do diretório mostra detalhes sobre uma API compatível, incluindo o nome dela, uma descrição breve do que ela faz e um link para a documentação. Uma API pode ter várias entradas do diretório, uma para cada versão compatível.
- Documento de descoberta: uma descrição legível por máquina de uma API específica. O documento de descoberta descreve a plataforma de uma versão específica de uma API. O documento apresenta detalhes sobre como acessar os vários métodos de cada API via chamadas HTTP RESTful. Um documento de descoberta contém descrições dos dados e métodos associados à API, além de informações sobre os escopos disponíveis do OAuth e descrições de esquemas, métodos, parâmetros e valores de parâmetros disponíveis.
Modelo de dados
Um recurso é uma entidade individual de dados com um identificador exclusivo. O serviço de descoberta de APIs do Google opera em dois tipos de recursos, com base nos conceitos acima.
Lista de diretórios de APIs: uma lista de APIs
Cada entrada do diretório contém um par de nome/versão da API com as seguintes informações:
- Informações de identificação e descrição: nome, versão, título e descrição.
- Informações da documentação: ícones e um link para a documentação.
- Informações de status, incluindo rótulos de status e uma indicação se essa é ou não a versão preferencial da API.
-
Link para o documento de descoberta, o URI do documento de descoberta dessa API (especificado como um URL completo, por exemplo,
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Recurso do documento de descoberta: uma descrição legível por máquina de uma API específica
Além das informações apresentadas no diretório de APIs, o documento de descoberta também contém:
- Esquemas, que é uma lista de esquemas de recursos da API que descrevem os dados aos quais você tem acesso em cada API. Os esquemas do serviço de descoberta de APIs do Google são baseados no esquema JSON.
- Métodos, incluindo uma lista de métodos de API e parâmetros disponíveis para cada método.
- Escopos do OAuth, que identifica a lista de escopos do OAuth disponíveis para essa API.
- Documentação inline, que contém descrições breves de esquemas, métodos, parâmetros e valores de parâmetros disponíveis.
A coleção de diretórios individuais é o contêiner conceitual do recurso do diretório de APIs individuais e dos recursos do documento de descoberta para cada API compatível.
Operações
É possível invocar dois métodos diferentes em coleções e recursos no serviço de descoberta de APIs do Google, conforme descrito na tabela a seguir.
| Operação | Descrição | Mapeamentos HTTP REST |
|---|---|---|
| list | Lista todas as APIs compatíveis. | GET no URI do recurso do diretório. |
Como chamar estilos
REST
As operações compatíveis do serviço de descoberta de APIs do Google são mapeadas diretamente com o verbo HTTP GET REST, conforme descrito em Operações.
O formato específico dos URIs do serviço de descoberta de APIs do Google é:
https://API/$discovery/rest?version=VERSION
em que API é o identificador de um recurso do documento de descoberta e VERSION é o identificador da versão específica da API.
Veja alguns exemplos de como isso funciona no serviço de descoberta de APIs do Google.
Liste todas as APIs compatíveis com o serviço de descoberta de APIs do Google:
GET https://discovery.googleapis.com/discovery/v1/apis
Acesse o documento de descoberta da API Service Usage, versão 1:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1