发现文档:list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
检索此端点支持的 API 列表。立即尝试。
discovery.apis.list 方法会返回 Google API Discovery Service 支持的所有 API 的列表。每个条目的数据都是该 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 的 ID。 |
|
items[].name |
string |
API 的名称。 |
|
items[].version |
string |
API 的版本。 |
|
items[].title |
string |
此 API 的标题。 |
|
items[].description |
string |
此 API 的说明。 |
|
items[].discoveryRestUrl |
string |
发现 REST 文档的网址。 |
|
items[].discoveryLink |
string |
指向发现文档的链接。 |
|
items[].icons |
object |
指向代表 API 的 16x16 和 32x32 图标的链接。 |
|
items[].icons.x16 |
string |
16x16 图标的网址。 |
|
items[].icons.x32 |
string |
32x32 图标的网址。 |
|
items[].documentationLink |
string |
直观易懂的 API 文档的链接。 |
|
items[].labels[] |
list |
此 API 的状态标签,例如 limited_availability 或 deprecated 。 |
|
items[].preferred |
boolean |
如果要使用的版本是此版本,则为 true 。 |
|
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2022-07-27。
[null,null,["最后更新时间 (UTC):2022-07-27。"],[[["\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. |"]]