api clients automation

APIクライアントの自動化

Algolia API クライアントは、オープンソースの openapi-generator ツールを利用して、OpenAPI 仕様から生成されます。

API クライアント自動化ドキュメント • Algolia ドキュメント

現在の API クライアントからの移行メモ

2022 年 7 月に、JavaScript、Java、および PHP 言語用に生成されたアルファ バージョンの API クライアントをリリースしました。これらのクライアントの最新の安定版を使用していて、アップグレードを検討している場合は、移行ガイドをお読みください。 Algolia ドキュメントで安定したクライアントのドキュメントを参照することができます。

クライアントと一緒に始める

getting startedガイドと API クライアントの使用方法については、ドキュメントを参照してください。

貢献する

新しいクライアントを追加するか、バグを修正したいですか?貢献ガイドを必ずご覧ください。

リポジトリツールのセットアップ

nvm use && yarn

開発環境のセットアップ

すべての API クライアントにツールをインストールする必要がないように、必ず Docker をインストールしてください。

yarn docker:setup

ドキュメントの詳細を読む

CLI

CLI を使用すると、ローカルで変更を加えたり、Docker コンテナーを通じてコマンドを実行したりできます。

• 仕様 CLI コマンド
• クライアントの CLI コマンド
• CTS CLI コマンド

ガイドと要件

ガイドと要件を読んで、次のことを行います。

• 新しいクライアントを追加する
• 新しい言語を追加する

テスト

以下を実行して、生成されたクライアントをテストします。

• playground (ドキュメントを参照)
• Common Test Suite (ドキュメントを参照)。

完全なドキュメントについては、オンライン ドキュメント を参照してください。

❓ トラブルシューティング

API クライアントで問題が発生しましたか?サポートに問い合わせる前に、FAQ にアクセスして、クライアントとの最も一般的な問題や注意事項に対する回答を見つけることをお勧めします。

GitHub で問題を開くこともできます。

?ライセンス

Algolia API クライアント自動化は、MIT ライセンスに基づいてライセンス供与されたオープンソース ソフトウェアです。