ドキュメント検索
ApidogをAlgoliaと統合して、APIドキュメントの検索機能を強化する方法を紹介します。
デフォルトでは、公開されたAPIドキュメントには組み込みの検索機能が含まれており、ユーザーは名前またはパスでエンドポイントやドキュメントを検索できます。
さらに、ApidogはAlgoliaとの統合により検索機能を強化しています。この機能を活用するには、機能を有効にして必要な設定を完了する必要があります。なお、Apidogのバージョンは2.6.31以上である必要があります。
Algoliaは無料で使用できますが、一定の制限があります。これらの制限を増やすには、Algoliaの有料版にアップグレードするか、無料のAlgolia DocSearchプランに申し込むことができます。
AlgoliaとApidogの統合
ApidogをAlgoliaと統合することで、APIドキュメントの検索機能を強化できます。以下の手順に従って設定してください:
ステップ1：Algoliaアカウントを作成
- Algoliaのウェブサイトにアクセスし、アカウントを登録します。
- 登録後、Algoliaアカウントにログインします。
ステップ2：Algoliaアプリケーションを作成
- ログイン後、Algoliaダッシュボードで新しいアプリケーションを作成します。
Upload a Fileをクリックしてデータをアップロードします。
設定を簡単にするために、提供されたサンプルコードを使用してJSONファイルを生成できます。JSONファイルをAlgoliaにドラッグ＆ドロップするだけです。JSONファイルの「名前がインデックス名」となり、後でApidogのドキュメント検索設定で使用することになります。
- 検索結果の表示をデザインします。
- 「次へ」 をクリックして最終ステップに進みます。
- 最終ステップでは、検索のフロントエンドをどのように構築するか尋ねられますが、このオプションはスキップできます。
ステップ3：ApidogをAlgolia設定で構成
- Algoliaダッシュボードで、アプリケーションの設定詳細を探します。
ここに「Index Name」が表示されます:
- これらの設定詳細をコピーし、Apidogのドキュメント検索設定に入力します。
ステップ4：設定を保存し、機能を有効にする
Apidogに必要な設定詳細を入力した後、設定を保存して強化された検索機能を有効にします。
Algoliaは無料で使用できますが、使用制限があります。制限を増やすには、有料プランにアップグレードするか、 無料のAlgolia DocSearchプランに申し込むことができます。
無料プランの制限に達した場合、Apidogに通知が表示されます:
無料のAlgolia DocSearchプラン
Algoliaは特定の目的（例えば、ドキュメント検索）のために無料のDocSearchプランを提供しています。こちらから無料のAlgolia DocSearchプランに申し込むことができます。申請フォームの ドキュメントURL フィールドには、Apidogからの公開APIドキュメントURLを入力できます。
申請が成功すると、Algoliaから確認のメールが届き、Algoliaダッシュボードにアプリケーションへの招待メッセージが表示されます。クリックして確認します。
確認後、関連するアプリケーションに切り替え、アプリケーション設定詳細をApidogに入力します。
同様に、「インデックス名」の値はここで見つけることができます:
