API Discovery cung cấp danh sách các API của Google để truy xuất siêu dữ liệu "Tài liệu khám phá" máy có thể đọc được; cho phép từng API.
Tài liệu này dành cho các nhà phát triển muốn viết thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác để tương tác với các API của Google.
Nền dịch vụ khám phá
Ý tưởng
Dịch vụ khám phá của các API của Google được xây dựng dựa trên hai khái niệm cơ bản:
- Thư mục API: Danh sách tất cả các API được Dịch vụ khám phá API hỗ trợ. Mỗi mục trong thư mục cho biết thông tin chi tiết về một API được hỗ trợ, bao gồm tên, API phần mô tả ngắn gọn về hoạt động của API và một đường liên kết đến tài liệu. Một API có thể có nhiều mục nhập trong Danh mục, mỗi mục có một phiên bản được hỗ trợ.
- Tài liệu khám phá: Nội dung mô tả về một máy có thể đọc được của một API cụ thể. Tài liệu về Khám phá mô tả nền tảng cho một phiên bản cụ thể của API. Tài liệu này cung cấp thông tin chi tiết về cách truy cập vào các phương thức khác nhau của từng API thông qua các lệnh gọi HTTP REST. Tài liệu Khám phá bao gồm nội dung mô tả về dữ liệu và phương thức liên kết với API, cũng như thông tin về các phạm vi OAuth có sẵn, nội dung mô tả về giản đồ, phương thức, thông số và giá trị thông số có sẵn.
Mô hình dữ liệu
Tài nguyên là một thực thể dữ liệu riêng lẻ có giá trị nhận dạng duy nhất. Dịch vụ khám phá của các API của Google hoạt động dựa trên hai loại tài nguyên, dựa trên các khái niệm nêu trên.
Danh sách API API: Danh sách các API
Mỗi mục trong thư mục chứa một cặp tên/phiên bản API có các thông tin sau:
- Thông tin nhận dạng và mô tả,: tên, phiên bản, tiêu đề và nội dung mô tả.
- Thông tin tài liệu: biểu tượng và liên kết tài liệu.
- Thông tin trạng thái, bao gồm cả nhãn trạng thái và chỉ báo cho biết đây có phải là phiên bản API ưu tiên hay không.
- Đường liên kết đến tài liệu khám phá, URI của tài liệu khám phá cho API này (có trên một URL đầy đủ, ví dụ: https://servicemanagement.googleapis.com/$Discovery/rest?version=v1).
Tài nguyên khám phá tài liệu: Mô tả máy có thể đọc được về một API cụ thể
Ngoài thông tin được cung cấp trong Thư mục API, tài liệu Khám phá cũng bao gồm:
- Lược đồ, là danh sách các giản đồ tài nguyên API mô tả dữ liệu mà bạn có quyền truy cập trong mỗi API; Giản đồ của API Google Khám phá dựa trên Lược đồ JSON.
- Phương thức, bao gồm danh sách các phương thức API và các thông số có sẵn cho từng phương thức.
- Các phạm vi OAuth giúp xác định danh sách các phạm vi OAuth có sẵn cho API này.
- Tài liệu cùng dòng, cung cấp thông tin mô tả ngắn gọn về giản đồ, phương thức, thông số và giá trị thông số có sẵn.
Một tập hợp Thư mục là vùng chứa khái niệm trong một tài nguyên Thư mục API và Tài nguyên khám phá đối với mỗi API được hỗ trợ.
Bạn có thể xem thêm thông tin chi tiết về tài nguyên Thư mục API và tài nguyên Khám phá trong tài liệu Sử dụng API và Tài liệu tham khảo.
Vận hành
Bạn có thể gọi hai phương thức khác nhau trên các tập hợp và tài nguyên trong Dịch vụ khám phá của API của Google, như được mô tả trong bảng sau.
| Hoạt động | Mô tả | Liên kết HTTP REST |
|---|---|---|
| list | Liệt kê tất cả các API được hỗ trợ. | GET trên URI tài nguyên của thư mục. |
Kiểu gọi
Kiến trúc chuyển trạng thái đại diện (REST)
Các hoạt động của Dịch vụ khám phá API của Google được hỗ trợ sẽ ánh xạ trực tiếp đến động từ REST HTTP GET, như được mô tả trong Hoạt động.
Định dạng cụ thể cho URI dịch vụ khám phá API của Google là:
https://discovery.googleapis.com/discovery/v1/apis?parameters
trong đó api là giá trị nhận dạng cho tài nguyên Tài liệu khám phá và version là giá trị nhận dạng của phiên bản API cụ thể và _parameters_ là bất kỳ tham số nào để áp dụng cho truy vấn. Xem phần Tóm tắt thông số truy vấn trong tài liệu tham khảo để biết thông tin chi tiết
Thông tin chi tiết về tập hợp đầy đủ các URI được sử dụng cho từng thao tác được hỗ trợ trong API được tóm tắt trong tài liệu Tài liệu tham khảo về dịch vụ khám phá của các API của Google.
Sau đây là một số ví dụ về cách thức hoạt động của dịch vụ này trong Dịch vụ khám phá API của Google.
Liệt kê tất cả các API được hỗ trợ trong Dịch vụ khám phá của Google API:
GET https://discovery.googleapis.com/discovery/v1/apis
Hãy thử ngay trong API Explorer!
Nhận tài liệu Khám phá cho API Quản lý dịch vụ đám mây của Google, phiên bản 1:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1