Discovery API 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á" có thể đọc được bằng máy cho từng API.
Tài liệu này dành cho những 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 API của Google.
Nền tảng của dịch vụ khám phá
Khái niệm
Dịch vụ Khám phá API của Google được xây dựng dựa trên 2 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 đều cho biết thông tin chi tiết về một API được hỗ trợ, bao gồm cả tên, nội dung mô tả ngắn gọn về chức năng và đường liên kết đến tài liệu. Một API có thể có nhiều mục trong Thư mục, mỗi mục cho một phiên bản được hỗ trợ.
- Tài liệu khám phá: Nội dung mô tả mà máy có thể đọc được về một API cụ thể. Tài liệu 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 nhiều phương thức của từng API thông qua các lệnh gọi HTTP tuân theo 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 hiện có và nội dung mô tả về lược đồ, phương thức, tham số và giá trị tham số hiện có.
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 riêng biệt. Dịch vụ Khám phá API của Google hoạt động trên 2 loại tài nguyên, dựa trên các khái niệm nêu trên.
Danh sách thư mục API: Danh sách API
Mỗi mục nhập trong thư mục chứa một cặp tên/phiên bản API kèm theo 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 về tài liệu: biểu tượng và đường liên kết đến tài liệu.
- Thông tin trạng thái, bao gồm cả nhãn trạng thái và thông tin 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 cung cấp dưới dạng một URL đầy đủ – ví dụ:
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Tài nguyên Tài liệu khám phá: Nội dung mô tả có thể đọc được bằng máy về một API cụ thể
Ngoài thông tin có trong Thư mục API, tài liệu Khám phá cũng bao gồm:
- Giản đồ, 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 Dịch vụ Khám phá API của Google dựa trên Giản đồ JSON.
- Phương thức, bao gồm danh sách các phương thức API và các tham số có sẵn cho từng phương thức.
- Phạm vi OAuth, xác định danh sách phạm vi OAuth có sẵn cho API này.
- Tài liệu nội tuyến, cung cấp nội dung mô tả ngắn gọn về các giản đồ, phương thức, tham số và giá trị tham số có sẵn.
Directory Collection là vùng chứa khái niệm của tài nguyên Directory API duy nhất và tài nguyên Discovery Document cho từng API được hỗ trợ.
Hoạt động tính toán
Bạn có thể gọi 2 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á API của Google, như mô tả trong bảng sau.
| Hoạt động | Mô tả | Mối 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 Thư mục. |
Kiểu gọi
REST
Các thao tác được hỗ trợ của Dịch vụ Khám phá API của Google có liên hệ trực tiếp đến động từ GET HTTP REST, như mô tả trong phần Thao tác.
Định dạng cụ thể cho URI của Dịch vụ Khám phá API của Google là:
https://API/$discovery/rest?version=VERSION
trong đó API là giá trị nhận dạng cho một 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 cụ thể của API.
Sau đây là một vài ví dụ về cách 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 Dịch vụ Khám phá API của Google hỗ trợ:
GET https://discovery.googleapis.com/discovery/v1/apis
Dùng thử ngay trong APIs Explorer!
Lấy tài liệu Khám phá cho Service Usage API, phiên bản 1:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1