Phương thức
Tài liệu về Khám phá tập trung vào phương pháp gọi API REST. Phương thức discovery.apis.list trả về danh sách tất cả các API mà Dịch vụ khám phá API của Google hỗ trợ, bao gồm cả url để truy xuất tài liệu khám phá dựa trên REST.
- list
- Truy xuất danh sách API được hỗ trợ tại điểm cuối này.
Xác thực tài nguyên
{ "kind": "discovery#restDescription", "discoveryVersion": "v1", "id": string, "name": string, "canonicalName": string, "version": string, "revision": string, "title": string, "description": string, "icons": { "x16": string, "x32": string }, "documentationLink": string, "labels": [ string ], "protocol": "rest", "baseUrl": string, "basePath": string, "rootUrl": string, "servicePath": string, "batchPath": "batch", "endpoints": [ { "endpointUrl": string, "location": string, "deprecated": boolean, "description": string } ], "parameters": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "auth": { "oauth2": { "scopes": { (key): { "description": string } } } }, "features": [ string ], "schemas": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "deprecated": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "enumDeprecated": [ boolean ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "methods": { (key): { "id": string, "path": string, "httpMethod": string, "description": string, "deprecated": boolean, "parameters": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "deprecated": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "enumDeprecated": [ boolean ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "parameterOrder": [ string ], "request": { "$ref": string }, "response": { "$ref": string }, "scopes": [ (value) ], "supportsMediaDownload": boolean, "supportsMediaUpload": boolean, "mediaUpload": { "accept": [ string ], "maxSize": string, "protocols": { "simple": { "multipart": true, "path": string }, "resumable": { "multipart": true, "path": string } } }, "supportsSubscription": boolean } }, "resources": { (key): { "methods": { (key): { "id": string, "path": string, "httpMethod": string, "description": string, "deprecated": boolean, "parameters": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "deprecated": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "enumDeprecated": [ boolean ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "parameterOrder": [ string ], "request": { "$ref": string }, "response": { "$ref": string }, "scopes": [ (value) ], "supportsMediaDownload": boolean, "supportsMediaUpload": boolean, "mediaUpload": { "accept": [ string ], "maxSize": string, "protocols": { "simple": { "multipart": true, "path": string }, "resumable": { "multipart": true, "path": string } } }, "supportsSubscription": boolean } }, "deprecated": boolean, "resources": { (key): (RestResource) } } } }
Tên thuộc tính | Giá trị | Mô tả | Ghi chú |
---|---|---|---|
kind |
string |
Loại cho phản hồi này.Chuỗi cố định discovery#restDescription . |
|
discoveryVersion |
string |
Cho biết phiên bản của API Discovery dùng để tạo tài liệu này. | |
id |
string |
Mã tài liệu Khám phá cho API. Ví dụ: urlshortener:v1 . |
|
name |
string |
Tên của API. Ví dụ: urlshortener . |
|
canonicalName |
string |
Tên chính tắc của API. Ví dụ: Url Shortener . |
|
version |
string |
Phiên bản của API. Ví dụ: v1 . |
|
revision |
string |
Bản sửa đổi của API. | |
title |
string |
Tiêu đề của API. Ví dụ: "Google URL Shortener API". | |
description |
string |
Mô tả của API này. | |
icons |
object |
Liên kết đến biểu tượng 16x16 và 32x32 đại diện cho API. | |
icons.x16 |
string |
URL của biểu tượng 16x16. | |
icons.x32 |
string |
URL của biểu tượng 32x32. | |
documentationLink |
string |
Đường liên kết đến tài liệu mà con người có thể đọc được cho API. | |
labels[] |
list |
Nhãn cho trạng thái của API này. Giá trị hợp lệ bao gồm limited_availability hoặc deprecated . |
|
protocol |
string |
Giao thức được mô tả trong tài liệu. Ví dụ: REST. | |
rootUrl |
string |
URL gốc chứa tất cả dịch vụ API. | |
endpoints[] |
list |
Danh sách đối tượng điểm cuối dựa trên vị trí của API này. Mỗi đối tượng chứa URL điểm cuối, vị trí, mô tả và trạng thái không dùng nữa. | |
endpoints[].endpointUrl |
string |
URL của máy chủ lưu trữ đích. | |
endpoints[].location |
string |
Vị trí của điểm cuối. | |
endpoints[].description |
string |
Chuỗi mô tả máy chủ lưu trữ do URL chỉ định. | |
endpoints[].deprecated |
boolean |
Liệu điểm cuối này có bị ngừng sử dụng hay không. | |
parameters |
object |
Các tham số phổ biến áp dụng cho tất cả API. | |
parameters.(key) |
nested object |
Mô tả một thông số. | |
parameters.(key).id |
string |
Giá trị nhận dạng duy nhất của giản đồ này. | |
parameters.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể tìm thấy danh sách các giá trị tại mục"loại" trong Giản đồ JSON. | |
parameters.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là mã của một giản đồ khác. | |
parameters.(key).description |
string |
Mô tả vật thể này. | |
parameters.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). | |
parameters.(key).required |
boolean |
Liệu tham số có bắt buộc hay không. | |
parameters.(key).format |
string |
Cụm từ thông dụng hoặc khóa bổ sung giúp ràng buộc giá trị. Để biết thêm chi tiết, hãy xem phần Tóm tắt loại và định dạng. | |
parameters.(key).pattern |
string |
Cụm từ thông dụng này phải tuân theo tham số. | |
parameters.(key).minimum |
string |
Giá trị nhỏ nhất của thông số này. | |
parameters.(key).maximum |
string |
Giá trị tối đa của tham số này. | |
parameters.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là enum). | |
parameters.(key).enumDescriptions[] |
list |
Mô tả các enum. Mỗi vị trí ánh xạ đến giá trị tương ứng trong mảng enum. | |
parameters.(key).repeated |
boolean |
Liệu thông số này có thể xuất hiện nhiều lần hay không. | |
parameters.(key).location |
string |
Liệu thông số này có xuất hiện trong truy vấn hay đường dẫn của các yêu cầu REST hay không. | |
parameters.(key).properties |
object |
Nếu đây là giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. | |
parameters.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Bản thân giá trị đó là một đối tượng Giản đồ JSON mô tả thuộc tính này. | |
parameters.(key).additionalProperties |
nested object |
Nếu đây là giản đồ cho một đối tượng, thì thuộc tính này sẽ là giản đồ cho mọi thuộc tính bổ sung có khóa động trên đối tượng này. | |
parameters.(key).items |
nested object |
Nếu đây là giản đồ cho một mảng thì thuộc tính này là giản đồ cho mỗi phần tử trong mảng. | |
parameters.(key).annotations |
object |
Thông tin bổ sung về cơ sở lưu trú này. | |
parameters.(key).annotations.required[] |
list |
Danh sách các phương thức yêu cầu thuộc tính này theo yêu cầu. | |
auth |
object |
Thông tin xác thực. | |
auth.oauth2 |
object |
Thông tin xác thực OAuth 2.0. | |
auth.oauth2.scopes |
object |
Phạm vi OAuth 2.0 sẵn có. | |
auth.oauth2.scopes.(key) |
object |
Giá trị phạm vi. | |
auth.oauth2.scopes.(key).description |
string |
Mô tả phạm vi. | |
features[] |
list |
Danh sách các tính năng được hỗ trợ cho API này. | |
schemas |
object |
Giản đồ cho API này. | |
schemas.(key) |
nested object |
Mô tả riêng của giản đồ. | |
schemas.(key).id |
string |
Giá trị nhận dạng duy nhất của giản đồ này. Ví dụ: URL |
|
schemas.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể tìm thấy danh sách các giá trị tại mục"loại" trong Giản đồ JSON. | |
schemas.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là mã của một giản đồ khác. | |
schemas.(key).description |
string |
Mô tả vật thể này. | |
schemas.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). | |
schemas.(key).required |
boolean |
Liệu tham số có bắt buộc hay không. | |
schemas.(key).deprecated |
boolean |
Liệu giản đồ này có bị ngừng sử dụng hay không. | |
schemas.(key).format |
string |
Cụm từ thông dụng hoặc khóa bổ sung giúp ràng buộc giá trị.Để biết thêm thông tin chi tiết, vui lòng xem Tóm tắt về loại và định dạng. | |
schemas.(key).pattern |
string |
Cụm từ thông dụng này phải tuân theo tham số. | |
schemas.(key).minimum |
string |
Giá trị nhỏ nhất của thông số này. | |
schemas.(key).maximum |
string |
Giá trị tối đa của tham số này. | |
schemas.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là enum). | |
schemas.(key).enumDescriptions[] |
list |
Mô tả các enum. Mỗi vị trí sẽ ánh xạ đến giá trị tương ứng trong mảng enum . |
|
schemas.(key).enumDeprecated[] |
list |
Trạng thái không dùng nữa cho các giá trị enum. Mỗi vị trí sẽ ánh xạ đến giá trị tương ứng trong mảng enum . |
|
schemas.(key).repeated |
boolean |
Liệu thông số này có thể xuất hiện nhiều lần hay không. | |
schemas.(key).location |
string |
Liệu thông số này có xuất hiện trong truy vấn hay đường dẫn của các yêu cầu REST hay không. | |
schemas.(key).properties |
object |
Nếu đây là giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. | |
schemas.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Bản thân giá trị đó là một đối tượng Giản đồ JSON mô tả thuộc tính này. | |
schemas.(key).additionalProperties |
nested object |
Nếu đây là giản đồ cho một đối tượng, thì thuộc tính này sẽ là giản đồ cho mọi thuộc tính bổ sung có khóa động trên đối tượng này. | |
schemas.(key).items |
nested object |
Nếu đây là giản đồ cho một mảng thì thuộc tính này là giản đồ cho mỗi phần tử trong mảng. | |
schemas.(key).annotations |
object |
Thông tin bổ sung về cơ sở lưu trú này. | |
schemas.(key).annotations.required[] |
list |
Danh sách các phương thức yêu cầu thuộc tính này theo yêu cầu. | |
methods |
object |
Phương thức cấp API cho API này. | |
methods.(key) |
nested object |
Mô tả từng phương thức. | |
methods.(key).id |
string |
ID duy nhất cho phương thức này. Bạn có thể sử dụng thuộc tính này để so khớp các phương thức giữa các phiên bản Khám phá. | |
methods.(key).description |
string |
Mô tả của phương pháp này. | |
methods.(key).deprecated |
boolean |
Liệu phương thức này có bị ngừng sử dụng hay không. | |
methods.(key).parameters |
object |
Thông tin chi tiết về tất cả các thông số trong phương thức này. | |
methods.(key).parameters.(key) |
nested object |
Thông tin chi tiết về một thông số duy nhất trong phương thức này. | |
methods.(key).parameters.(key).id |
string |
Giá trị nhận dạng duy nhất của giản đồ này. | |
methods.(key).parameters.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể tìm thấy danh sách các giá trị tại mục"loại" trong Giản đồ JSON. | |
methods.(key).parameters.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là mã của một giản đồ khác. | |
methods.(key).parameters.(key).description |
string |
Mô tả vật thể này. | |
methods.(key).parameters.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). | |
methods.(key).parameters.(key).required |
boolean |
Liệu tham số có bắt buộc hay không. | |
methods.(key).parameters.(key).deprecated |
boolean |
Liệu thông số này có bị ngừng sử dụng hay không. | |
methods.(key).parameters.(key).format |
string |
Cụm từ thông dụng hoặc khóa bổ sung giúp ràng buộc giá trị.Để biết thêm thông tin chi tiết, vui lòng xem Tóm tắt về loại và định dạng. | |
methods.(key).parameters.(key).pattern |
string |
Cụm từ thông dụng này phải tuân theo tham số. | |
methods.(key).parameters.(key).minimum |
string |
Giá trị nhỏ nhất của thông số này. | |
methods.(key).parameters.(key).maximum |
string |
Giá trị tối đa của tham số này. | |
methods.(key).parameters.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là enum). | |
methods.(key).parameters.(key).enumDescriptions[] |
list |
Mô tả các enum. Mỗi vị trí sẽ ánh xạ đến giá trị tương ứng trong mảng enum . |
|
methods.(key).parameters.(key).enumDeprecated[] |
list |
Trạng thái không dùng nữa cho các giá trị enum. Mỗi vị trí sẽ ánh xạ đến giá trị tương ứng trong mảng enum . |
|
methods.(key).parameters.(key).repeated |
boolean |
Liệu thông số này có thể xuất hiện nhiều lần hay không. | |
methods.(key).parameters.(key).location |
string |
Liệu thông số này có xuất hiện trong truy vấn hay đường dẫn của các yêu cầu REST hay không. | |
methods.(key).parameters.(key).properties |
object |
Nếu đây là giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. | |
methods.(key).parameters.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Bản thân giá trị đó là một đối tượng Giản đồ JSON mô tả thuộc tính này. | |
methods.(key).parameters.(key).additionalProperties |
nested object |
Nếu đây là giản đồ cho một đối tượng, thì thuộc tính này sẽ là giản đồ cho mọi thuộc tính bổ sung có khóa động trên đối tượng này. | |
methods.(key).parameters.(key).items |
nested object |
Nếu đây là giản đồ cho một mảng thì thuộc tính này là giản đồ cho mỗi phần tử trong mảng. | |
methods.(key).parameters.(key).annotations |
object |
Thông tin bổ sung về cơ sở lưu trú này. | |
methods.(key).parameters.(key).annotations.required[] |
list |
Danh sách phương thức mà thuộc tính này yêu cầu theo yêu cầu. | |
methods.(key).parameterOrder[] |
list |
Danh sách tham số bắt buộc được sắp xếp theo thứ tự. Đây là gợi ý cho khách hàng về cách cấu trúc chữ ký phương thức. Mảng được sắp xếp sao cho thông số quan trọng nhất xuất hiện đầu tiên. | |
methods.(key).scopes[] |
list |
Phạm vi OAuth 2.0 áp dụng cho phương thức này. | |
methods.(key).supportsMediaDownload |
boolean |
Liệu phương thức này có hỗ trợ việc tải nội dung nghe nhìn xuống hay không. | |
methods.(key).supportsMediaUpload |
boolean |
Liệu phương thức này có hỗ trợ việc tải nội dung nghe nhìn lên hay không. | |
methods.(key).mediaUpload |
object |
Thông số tải lên phương tiện. | |
methods.(key).mediaUpload.accept[] |
list |
MIME Media Ranges cho phương tiện tải lên được chấp nhận cho phương pháp này. | |
methods.(key).mediaUpload.maxSize |
string |
Kích thước tối đa của nội dung tải lên phương tiện, chẳng hạn như "1MB", "2GB" hoặc "3TB". | |
methods.(key).supportsSubscription |
boolean |
Phương thức này có hỗ trợ gói đăng ký không. | |
baseUrl |
string |
[KHÔNG DÙNG NỮA] URL cơ sở cho yêu cầu REST. | |
basePath |
string |
[KHÔNG DÙNG NỮA] Đường dẫn cơ sở cho yêu cầu REST. | |
servicePath |
string |
Đường dẫn cơ sở cho tất cả yêu cầu REST. | |
batchPath |
string |
Đường dẫn cho các yêu cầu lô REST. | |
methods.(key).path |
string |
Đường dẫn URI của phương thức REST này. Bạn nên sử dụng kết hợp này với thuộc tính servicePath ở cấp API. |
|
methods.(key).httpMethod |
string |
Phương thức HTTP mà phương thức này sử dụng. | |
methods.(key).request |
object |
Giản đồ cho yêu cầu. | |
methods.(key).request.$ref |
string |
Mã giản đồ cho giản đồ yêu cầu. | |
methods.(key).request.parameterName |
string |
[KHÔNG DÙNG NỮA] Một số API có trường này vì lý do tương thích ngược. Bạn có thể bỏ qua thuộc tính này một cách an toàn. | |
methods.(key).response |
object |
Giản đồ cho phản hồi. | |
methods.(key).response.$ref |
string |
Mã giản đồ cho giản đồ phản hồi. | |
methods.(key).mediaUpload.protocols |
object |
Các giao thức tải lên được hỗ trợ. | |
methods.(key).mediaUpload.protocols.simple |
object |
Hỗ trợ tải lên dưới dạng một yêu cầu HTTP. | |
methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
Đúng nếu điểm cuối này hỗ trợ việc tải nội dung nghe nhìn có nhiều phần lên. | |
methods.(key).mediaUpload.protocols.simple.path |
string |
Đường dẫn URI được dùng để tải lên. Nên được sử dụng kết hợp với thuộc tính rootURL ở cấp độ api. |
|
methods.(key).mediaUpload.protocols.resumable |
object |
Hỗ trợ giao thức Tải lên phương tiện có thể tiếp tục. | |
methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true nếu điểm cuối này hỗ trợ việc tải nội dung nghe nhìn có nhiều phần lên. |
|
methods.(key).mediaUpload.protocols.resumable.path |
string |
Đường dẫn URI được dùng để tải lên. Bạn nên sử dụng kết hợp này với thuộc tính rootURL ở cấp API. |
|
resources |
object |
Các tài nguyên trong API này. | |
resources.(key) |
nested object |
Mô tả tài nguyên riêng lẻ. Chứa các phương thức và tài nguyên phụ liên quan đến tài nguyên này. | |
resources.(key).methods |
object |
Phương thức cho tài nguyên này. | |
resources.(key).methods.(key) |
nested object |
Mô tả cho bất kỳ phương pháp nào trên tài nguyên này. | |
resources.(key).methods.(key).id |
string |
ID duy nhất cho phương thức này. Bạn có thể sử dụng thuộc tính này để so khớp các phương thức giữa các phiên bản Khám phá. | |
resources.(key).methods.(key).path |
string |
Đường dẫn URI của phương thức REST này. Bạn nên sử dụng kết hợp này với thuộc tính servicePath ở cấp API. |
|
resources.(key).methods.(key).flatPath |
string |
Đường dẫn URI của phương thức REST này ở định dạng (RFC 6570) không có các tính năng cấp 2 ({+var}). Bổ sung cho thuộc tính path . |
|
resources.(key).methods.(key).httpMethod |
string |
Phương thức HTTP mà phương thức này sử dụng. | |
resources.(key).methods.(key).description |
string |
Mô tả của phương pháp này. | |
resources.(key).methods.(key).deprecated |
boolean |
Liệu phương thức này có bị ngừng sử dụng hay không. | |
resources.(key).methods.(key).parameters |
object |
Thông tin chi tiết về tất cả các thông số trong phương thức này. | |
resources.(key).methods.(key).parameters.(key) |
nested object |
Thông tin chi tiết về một thông số duy nhất trong phương thức này. | |
resources.(key).methods.(key).parameters.(key).id |
string |
Giá trị nhận dạng duy nhất của giản đồ này. | |
resources.(key).methods.(key).parameters.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể tìm thấy danh sách các giá trị tại mục"loại" trong Giản đồ JSON. | |
resources.(key).methods.(key).parameters.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là "ID" của một giản đồ khác. | |
resources.(key).methods.(key).parameters.(key).description |
string |
Mô tả vật thể này. | |
resources.(key).methods.(key).parameters.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). | |
resources.(key).methods.(key).parameters.(key).required |
boolean |
Liệu tham số có bắt buộc hay không. | |
resources.(key).methods.(key).parameters.(key).deprecated |
boolean |
Liệu thông số này có bị ngừng sử dụng hay không. | |
resources.(key).methods.(key).parameters.(key).format |
string |
Cụm từ thông dụng hoặc khóa bổ sung giúp ràng buộc giá trị.Để biết thêm thông tin chi tiết, vui lòng xem Tóm tắt về loại và định dạng. | |
resources.(key).methods.(key).parameters.(key).pattern |
string |
Cụm từ thông dụng này phải tuân theo tham số. | |
resources.(key).methods.(key).parameters.(key).minimum |
string |
Giá trị nhỏ nhất của thông số này. | |
resources.(key).methods.(key).parameters.(key).maximum |
string |
Giá trị tối đa của tham số này. | |
resources.(key).methods.(key).parameters.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là enum). | |
resources.(key).methods.(key).parameters.(key).enumDescriptions[] |
list |
Mô tả các enum. Mỗi vị trí sẽ ánh xạ đến giá trị tương ứng trong mảng enum . |
|
resources.(key).methods.(key).parameters.(key).enumDeprecated[] |
list |
Trạng thái không dùng nữa cho các giá trị enum. Mỗi vị trí sẽ ánh xạ đến giá trị tương ứng trong mảng enum . |
|
resources.(key).methods.(key).parameters.(key).repeated |
boolean |
Liệu thông số này có thể xuất hiện nhiều lần hay không. | |
resources.(key).methods.(key).parameters.(key).location |
string |
Liệu thông số này có xuất hiện trong truy vấn hay đường dẫn của các yêu cầu REST hay không. | |
resources.(key).methods.(key).parameters.(key).properties |
object |
Nếu đây là giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. | |
resources.(key).methods.(key).parameters.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Bản thân giá trị đó là một đối tượng Giản đồ JSON mô tả thuộc tính này. | |
resources.(key).methods.(key).parameters.(key).additionalProperties |
nested object |
Nếu đây là giản đồ cho một đối tượng, thì thuộc tính này sẽ là giản đồ cho mọi thuộc tính bổ sung có khóa động trên đối tượng này. | |
resources.(key).methods.(key).parameters.(key).items |
nested object |
Nếu đây là giản đồ cho một mảng thì thuộc tính này là giản đồ cho mỗi phần tử trong mảng. | |
resources.(key).methods.(key).parameters.(key).annotations |
object |
Thông tin bổ sung về cơ sở lưu trú này. | |
resources.(key).methods.(key).parameters.(key).annotations.required[] |
list |
Danh sách các phương thức yêu cầu thuộc tính này theo yêu cầu. | |
resources.(key).methods.(key).parameterOrder[] |
list |
Danh sách tham số bắt buộc được sắp xếp theo thứ tự. Đây là gợi ý cho khách hàng về cách cấu trúc chữ ký phương thức. Mảng được sắp xếp sao cho thông số quan trọng nhất xuất hiện đầu tiên. | |
resources.(key).methods.(key).request |
object |
Giản đồ cho yêu cầu. | |
resources.(key).methods.(key).request.$ref |
string |
Mã giản đồ cho giản đồ yêu cầu. | |
resources.(key).methods.(key).response |
object |
Giản đồ cho phản hồi. | |
resources.(key).methods.(key).response.$ref |
string |
Mã giản đồ cho giản đồ phản hồi. | |
resources.(key).methods.(key).scopes[] |
list |
Phạm vi OAuth 2.0 áp dụng cho phương thức này. | |
resources.(key).methods.(key).supportsMediaDownload |
boolean |
Liệu phương thức này có hỗ trợ việc tải nội dung nghe nhìn xuống hay không. | |
resources.(key).methods.(key).supportsMediaUpload |
boolean |
Liệu phương thức này có hỗ trợ việc tải nội dung nghe nhìn lên hay không. | |
resources.(key).methods.(key).mediaUpload |
object |
Thông số tải lên phương tiện. | |
resources.(key).methods.(key).mediaUpload.accept[] |
list |
MIME Media Ranges cho phương tiện tải lên được chấp nhận cho phương pháp này. | |
resources.(key).methods.(key).mediaUpload.maxSize |
string |
Kích thước tối đa của nội dung tải lên phương tiện, chẳng hạn như "1MB", "2GB" hoặc "3TB". | |
resources.(key).methods.(key).mediaUpload.protocols |
object |
Các giao thức tải lên được hỗ trợ. | |
resources.(key).methods.(key).mediaUpload.protocols.simple |
object |
Hỗ trợ tải lên dưới dạng một yêu cầu HTTP. | |
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
true nếu điểm cuối này hỗ trợ việc tải nội dung nghe nhìn có nhiều phần lên. |
|
resources.(key).methods.(key).mediaUpload.protocols.simple.path |
string |
Đường dẫn URI được dùng để tải lên. Bạn nên sử dụng kết hợp này với thuộc tính rootURL ở cấp API. |
|
resources.(key).methods.(key).mediaUpload.protocols.resumable |
object |
Hỗ trợ giao thức Tải lên phương tiện có thể tiếp tục. | |
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true nếu điểm cuối này hỗ trợ việc tải nội dung nghe nhìn có nhiều phần lên. |
|
resources.(key).methods.(key).mediaUpload.protocols.resumable.path |
string |
Đường dẫn URI được dùng để tải lên. Bạn nên sử dụng kết hợp này với thuộc tính rootURL ở cấp API. |
|
resources.(key).methods.(key).supportsSubscription |
boolean |
Phương thức này có hỗ trợ gói đăng ký không. | |
resources.(key).deprecated |
boolean |
Liệu tài nguyên này có bị ngừng sử dụng hay không. | |
resources.(key).resources |
object |
Tài nguyên phụ trên tài nguyên này. | |
resources.(key).resources.(key) |
nested object |
Mô tả cho bất kỳ tài nguyên phụ nào trên tài nguyên này. |