本頁面說明程式庫與工具,並提供其他資訊,協助您開始使用 Java 適用的 Endpoints Frameworks。如要瞭解 Endpoints Frameworks 的架構總覽,請參閱「關於 Endpoints Frameworks」。
程式庫和工具
App Engine 標準環境適用的 Cloud Endpoints Frameworks 提供下列程式庫和工具:
- 群組
com.google.endpoints
的 Maven Central Repository 提供 Endpoints Frameworks。基本所需的.jar
檔案則位於endpoints-framework
構件中。詳情請參閱 API Javadoc。 endpoints
指令列工具 (適用於 Linux) 或endpoints.cmd
(適用於 Windows),可用來產生用戶端程式庫套裝組合和探索文件,讓 Android 應用程式和其他類型的用戶端應用程式存取您的 API。- Endpoints Frameworks Maven 外掛程式和 Endpoints Frameworks Gradle 外掛程式,可用於產生下列項目:
- 用戶端程式庫套裝組合和探索文件。
- OpenAPI 設定檔:可視需要用於 API 管理功能,例如監控、記錄和 API 金鑰驗證。
需求條件
如要使用 Endpoints Frameworks,請按照教學課程中的流程進行。
您必須瞭解如何開發所選的用戶端 (例如 JavaScript Web 用戶端) 或行動用戶端 (例如 Android)。
開發流程
下列為透過 Endpoints Frameworks 開發應用程式的一般工作流程:
- 建立您的 API 專案,然後編寫 API 程式碼。
- 為 API 新增註解,讓系統據以產生類別及用戶端程式庫。
- 產生 OpenAPI 設定檔,並按照教學課程中的說明部署設定檔。
- (選用) 在本機測試您的 API。
- 部署 API。
- 產生用戶端程式庫。
- 呼叫 API 時,使用用戶端程式庫編寫您的用戶端應用程式。
開始使用
請前往教學課程,瞭解如何設定、部署及傳送要求到範例 API。然後再回到本節,取得設定、部署及測試自己 API 的必要資訊。
從 Endpoints 1.0 版遷移
如果您已透過 Endpoints 先前版本開發 API 後端,請按照遷移指南,將應用程式遷移到 Endpoints 2.0 版。