Документ обнаружения: список
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Получите список API, поддерживаемых в этой конечной точке. Попробуйте прямо сейчас .
Метод discovery.apis.list возвращает список всех API, поддерживаемых службой обнаружения API Google. Данные для каждой записи представляют собой подмножество документа обнаружения для этого API, а список содержит каталог поддерживаемых API. Если конкретный API имеет несколько версий, каждая из версий имеет свою собственную запись в списке.
Запрос
HTTP-запрос
GET https://discovery.googleapis.com/discovery/v1/apis
Параметры
Имя параметра | Ценность | Описание |
---|
Дополнительные параметры |
name | string | Включайте только API с заданным именем. |
preferred | boolean | Возвращайте только предпочтительную версию API. " false " по умолчанию. |
Тело запроса
Не указывайте тело запроса с этим методом.
Ответ
В случае успеха этот метод возвращает тело ответа со следующей структурой:
{
"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
}
]
}
Имя свойства | Ценность | Описание | Заметки |
---|
kind | string | Фиксированная строка discovery#directoryList | |
discoveryVersion | string | Укажите версию Discovery API, которая использовалась для создания этого документа. | |
items[] | list | Отдельные записи каталога. Одна запись на пару API/версия. | |
items[]. kind | string | Тип для этого ответа. | |
items[]. id | string | Идентификатор этого API. | |
items[]. name | string | Имя API. | |
items[]. version | string | Версия API. | |
items[]. title | string | Название этого API. | |
items[]. description | string | Описание этого API. | |
items[]. discoveryRestUrl | string | URL-адрес документа REST обнаружения. | |
items[]. discoveryLink | string | Ссылка на документ открытия. | |
items[]. icons | object | Ссылки на значки 16 x 16 и 32 x 32, представляющие API. | |
items[].icons. x16 | string | URL значка 16x16. | |
items[].icons. x32 | string | URL значка 32x32. | |
items[]. documentationLink | string | Ссылка на удобочитаемую документацию по API. | |
items[]. labels[] | list | Ярлыки для статуса этого API, такие как limited_availability или deprecated . | |
items[]. preferred | boolean | true , если эта версия является предпочтительной для использования. | |
Попытайся!
Используйте проводник ниже, чтобы вызвать этот метод для оперативных данных и посмотреть ответ. В качестве альтернативы попробуйте автономный проводник .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2022-07-27 UTC.
[null,null,["Последнее обновление: 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. |"]]