Documento de descubrimiento: lista
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recupera la lista de las API compatibles en este extremo.
Pruébalo ahora.
El método discovery.apis.list muestra la lista de todas las API admitidas por el servicio de descubrimiento de API de Google. Los datos de cada entrada son un subconjunto del documento de descubrimiento para esa API, y la lista proporciona un directorio de API compatibles. Si una API específica tiene varias versiones, cada una tiene su propia entrada en la lista.
Solicitud
Solicitud HTTP
GET https://discovery.googleapis.com/discovery/v1/apis
Parámetros
Nombre del parámetro |
Valor |
Descripción |
Parámetros opcionales |
name |
string |
Incluye solo las API con ese nombre.
|
preferred |
boolean |
Muestra solo la versión preferida de una API. false de forma predeterminada.
|
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud con este método.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{
"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
}
]
}
Nombre de propiedad |
Valor |
Descripción |
Notas |
kind |
string |
La string discovery discovery#directoryList |
|
discoveryVersion |
string |
Indica la versión de la API de descubrimiento que se usó para generar este documento. |
|
items[] |
list |
Las entradas individuales del directorio. Una entrada por par de versión de API. |
|
items[].kind |
string |
El tipo de esta respuesta. |
|
items[].id |
string |
Es el ID de esta API. |
|
items[].name |
string |
El nombre de la API. |
|
items[].version |
string |
La versión de la API. |
|
items[].title |
string |
El título de esta API. |
|
items[].description |
string |
Es la descripción de esta API. |
|
items[].discoveryRestUrl |
string |
La URL del documento REST de descubrimiento. |
|
items[].discoveryLink |
string |
Un vínculo al documento de descubrimiento. |
|
items[].icons |
object |
Vínculos a íconos de 16 x 16 y 32 x 32 que representan la API. |
|
items[].icons.x16 |
string |
La URL del ícono de 16x16. |
|
items[].icons.x32 |
string |
La URL del ícono de 32 x 32. |
|
items[].documentationLink |
string |
Un vínculo a documentación legible de la API. |
|
items[].labels[] |
list |
Etiquetas para el estado de esta API, como limited_availability o deprecated . |
|
items[].preferred |
boolean |
true si esta es la versión preferida para usar. |
|
Pruébalo
Usa el explorador que aparece a continuación para llamar a este método con datos en vivo y ver la respuesta.
También puedes probar el explorador independiente.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2022-07-27 (UTC)
[null,null,["Última actualización: 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. |"]]