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 许可证授权的开源软件。