api clients automation

API 用戶端自動化

Algolia API 用戶端是根據 OpenAPI 規格產生的，利用開源 openapi-generator 工具。

API 用戶端自動化文件 • Algolia 文檔

當前 API 用戶端的遷移說明

2022 年 7 月，我們發布了為 JavaScript、Java 和 PHP 語言產生的 API 用戶端的 alpha 版本。如果您使用的是這些客戶端的最新穩定版本並希望升級，請閱讀遷移指南。您仍然可以在 Algolia 文件上瀏覽穩定客戶端的文件。

開始與客戶打交道

您可以在我們的文件中閱讀getting started指南以及如何使用 API 用戶端。

貢獻

想要新增客戶端或修復錯誤？請務必查看我們的貢獻指南。

設定存儲庫工具

nvm use && yarn

設定開發環境

確保安裝了 Docker，這樣您就不必為每個 API 用戶端安裝工具。

yarn docker:setup

閱讀我們文件的更多內容

命令列介面

CLI 允許您在本機上進行變更並透過 docker 容器執行命令。

• 規格 CLI 命令
• 客戶端 CLI 指令
• CTS CLI 指令

指南和要求

閱讀指南和要求：

• 新增客戶
• 新增語言

測試

透過執行以下命令來測試產生的客戶端：

• playground （參見文件）
• Common Test Suite （請參閱文件）。

如需完整文檔，請造訪線上文檔。

❓ 故障排除

遇到 API 客戶端問題？在尋求支援之前，我們建議您先查看我們的常見問題解答，您可以在其中找到最常見問題和客戶遇到的問題的答案。

您也可以在 GitHub 上提出問題。

？執照

Algolia API 用戶端自動化是一款根據 MIT 授權授權的開源軟體。