검색 문서: 목록
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
이 엔드포인트에서 지원되는 API 목록을 검색합니다.
지금 사용해 보기
discovery.apis.list 메서드는 Google API 검색 서비스에서 지원하는 모든 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/버전 쌍당 1개의 항목 |
|
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 문서의 URL입니다. |
|
items[].discoveryLink |
string |
검색 문서 링크 |
|
items[].icons |
object |
API를 나타내는 16x16 및 32x32 아이콘 링크 |
|
items[].icons.x16 |
string |
16x16 아이콘의 URL입니다. |
|
items[].icons.x32 |
string |
32x32 아이콘의 URL입니다. |
|
items[].documentationLink |
string |
사람이 읽을 수 있는 API 문서 링크 |
|
items[].labels[] |
list |
이 API의 상태 라벨(예: limited_availability 또는 deprecated ) |
|
items[].preferred |
boolean |
이 버전이 선호되는 버전인 경우 true 입니다. |
|
사용해 보기는
아래 탐색기를 사용하여 실시간 데이터에서 이 메서드를 호출하고 응답을 확인하세요.
또는 독립형 탐색기를 사용해 보세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 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. |"]]