Documento de descoberta: lista
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupere a lista de APIs compatíveis com este endpoint.
Faça o teste agora.
O método discovery.apis.list retorna a lista de todas as APIs compatíveis com o serviço de descoberta de APIs do Google. Os dados de cada entrada são um subconjunto do documento do Discovery dessa API, e a lista fornece um diretório de APIs compatíveis. Se uma API específica tiver várias versões, cada uma delas terá a própria entrada na lista.
Solicitação
Solicitação HTTP
GET https://discovery.googleapis.com/discovery/v1/apis
Parâmetros
Nome do parâmetro |
Valor |
Descrição |
Parâmetros opcionais |
name |
string |
Inclua somente APIs com o nome fornecido.
|
preferred |
boolean |
Retornar somente a versão preferencial de uma API. "false " por padrão.
|
Corpo da solicitação
Não forneça um corpo de solicitação com este método.
Resposta
Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:
{
"kind": "discovery#directoryList",
"discoveryVersion": "v1",
"items": [
{
"kind": "discovery#directoryItem",
"id": string,
"name": string,
"version": string,
"title": string,
"description": string,
"discoveryRestUrl": string,
"discoveryLink": string,
"icons": {
"x16": string,
"x32": string
},
"documentationLink": string,
"labels": [
string
],
"preferred": boolean
}
]
}
Nome da propriedade |
Valor |
Descrição |
Observações |
kind |
string |
A string fixa discovery#directoryList |
|
discoveryVersion |
string |
Indique a versão da API Discovery usada para gerar esse documento. |
|
items[] |
list |
As entradas do diretório individuais. Uma entrada por par de API/versão. |
|
items[].kind |
string |
Tipo dessa resposta. |
|
items[].id |
string |
O ID desta API. |
|
items[].name |
string |
É o nome da API. |
|
items[].version |
string |
A versão da API. |
|
items[].title |
string |
O título desta API. |
|
items[].description |
string |
É a descrição da API. |
|
items[].discoveryRestUrl |
string |
O URL para o documento REST de descoberta. |
|
items[].discoveryLink |
string |
Um link para o documento de descoberta. |
|
items[].icons |
object |
Links para ícones de 16 x 16 e 32 x 32 que representam a API. |
|
items[].icons.x16 |
string |
É o URL do ícone de 16 x 16. |
|
items[].icons.x32 |
string |
É o URL do ícone de 32 x 32. |
|
items[].documentationLink |
string |
Um link para a documentação legível da API. |
|
items[].labels[] |
list |
Rótulos para o status desta API, como limited_availability ou deprecated . |
|
items[].preferred |
boolean |
true se esta for a versão preferencial. |
|
Faça o teste!
Use o explorador abaixo para chamar esse método em dados ativos e ver a resposta.
Se preferir, use o
explorador
autônomo.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2022-07-27 UTC.
[null,null,["Última atualização 2022-07-27 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ediscovery.apis.list\u003c/code\u003e endpoint retrieves a list of all APIs supported by the Google APIs Discovery Service.\u003c/p\u003e\n"],["\u003cp\u003eEach API and its versions are represented as individual entries in the response.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter results using optional parameters like \u003ccode\u003ename\u003c/code\u003e to include specific APIs or \u003ccode\u003epreferred\u003c/code\u003e to return only preferred versions.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides comprehensive information about each API, including its ID, name, version, description, documentation link, and icons.\u003c/p\u003e\n"]]],[],null,["# Discovery Document: list\n\nRetrieve the list of APIs supported at this endpoint.\n\n\nThe `discovery.apis.list` method returns the list of all APIs supported by the\nGoogle APIs Discovery Service. The data for each entry is a subset of the Discovery Document\nfor that API, and the list provides a directory of supported APIs. If a specific API\nhas multiple versions, each of the versions has its own entry in the list.\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://discovery.googleapis.com/discovery/v1/apis\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|----------------|-----------|--------------------------------------------------------------------|\n| **Optional Parameters** |||\n| `name` | `string` | Only include APIs with the given name. |\n| `preferred` | `boolean` | Return only the preferred version of an API. \"`false`\" by default. |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": \"discovery#directoryList\",\n \"discoveryVersion\": \"v1\",\n \"items\": [\n {\n \"kind\": \"discovery#directoryItem\",\n \"id\": string,\n \"name\": string,\n \"version\": string,\n \"title\": string,\n \"description\": string,\n \"discoveryRestUrl\": string,\n \"discoveryLink\": string,\n \"icons\": {\n \"x16\": string,\n \"x32\": string\n },\n \"documentationLink\": string,\n \"labels\": [\n string\n ],\n \"preferred\": boolean\n }\n ]\n}\n```\n\n| Property Name | Value | Description |\n|-----------------------------|-----------|------------------------------------------------------------------------------------|\n| `kind` | `string` | The fixed string discovery#directoryList |\n| `discoveryVersion` | `string` | Indicate the version of the Discovery API used to generate this doc. |\n| `items[]` | `list` | The individual directory entries. One entry per API/version pair. |\n| items[].`kind` | `string` | The kind for this response. |\n| items[].`id` | `string` | The ID of this API. |\n| items[].`name` | `string` | The name of the API. |\n| items[].`version` | `string` | The version of the API. |\n| items[].`title` | `string` | The title of this API. |\n| items[].`description` | `string` | The description of this API. |\n| items[].`discoveryRestUrl` | `string` | The url for the discovery REST document. |\n| items[].`discoveryLink` | `string` | A link to the discovery document. |\n| items[].`icons` | `object` | Links to 16x16 and 32x32 icons representing the API. |\n| items[].icons.`x16` | `string` | The url of the 16x16 icon. |\n| items[].icons.`x32` | `string` | The url of the 32x32 icon. |\n| items[].`documentationLink` | `string` | A link to human readable documentation for the API. |\n| items[].`labels[]` | `list` | Labels for the status of this API, such as `limited_availability` or `deprecated`. |\n| items[].`preferred` | `boolean` | `true` if this version is the preferred version to use. |"]]