APIドキュメントの完成に多くの時間を費やしたかもしれません。しかし、検索エンジンで関連キーワードを検索しても、ドキュメントが結果に表示されることはほとんどありません。これはコンテンツが貧弱だからではなく、ドキュメントサイトに不可欠なSEO最適化が不足していることが原因です。
Apidogで公開されたオンラインドキュメントサイトには、サイトマップ生成、robotsファイル管理、セマンティックURL、各ページにカスタマイズ可能なメタデータタグなど、デフォルトで様々なSEO最適化機能が組み込まれています。これらはすべて、検索エンジンがコンテンツを効果的にクロールおよびインデックスするために不可欠です。
これらのデフォルト設定に加えて、特定のニーズに合わせてSEO設定を詳細に調整できます。機能はページレベル設定とサイトレベル設定の2つのレベルに分かれています。ページレベル設定では個々のエンドポイントまたはMarkdownドキュメントを最適化でき、サイトレベル設定ではドキュメントサイト全体の統合管理が可能です。
詳細を見ていきましょう。Apidogのバージョンが古い場合は、まず最新バージョンにアップデートすることをお勧めします（下のダウンロードボタンをクリックしてください）。
ApidogでのページレベルSEO設定の構成
ページレベルSEO設定を使用すると、各エンドポイントまたはMarkdownドキュメントページが検索エンジンにどのように表示されるかを最適化できます。構成はシンプルで、可視性とクリック率を大幅に向上させることができます。
ページレベルSEO設定の構成方法
ステップ1：最適化したいページを開く
プロジェクト内で目的のエンドポイントまたはMarkdownドキュメントページに移動します。
ステップ2：SEO設定アイコンをクリックする
ページ右上のSEO Settingsアイコンを探します。それをクリックして設定パネルを開きます。
ステップ3：カスタムURLスラッグを設定する
デフォルトでは、ドキュメントページのURLは数字の羅列でシステム生成されます（例：https://your-domain.com/5702007m0）。これは読みにくく、SEOフレンドリーではありません。
エンドポイント「Find pet by ID」に対して意味のあるURLスラッグ「find-pet-by-id」を入力すると、URLはhttps://your-domain.com/find-pet-by-idのようになります。これにより、URLがより明確になり、覚えやすくなります。
ステップ4：メタタイトルとメタディスクリプションを編集する
メタタイトル：検索結果に表示される青い見出しです。明確でキーワードが豊富なタイトルは、ランキングを向上させ、クリックを促します。
メタディスクリプション：検索結果でタイトルの下に表示されることがあるテキストです。検索エンジンが自動生成する場合もありますが、適切に記述された説明は、ユーザーがページのコンテンツを素早く理解するのに役立ちます。
ステップ5：関連キーワードを追加する（オプション）
今日、検索エンジンはメタキーワードへの依存度を下げていますが、追加することでページのトピックを示すことができます。例えば、エンドポイント「Find pet by ID」に対して、以下のようなキーワードを追加すると良いでしょう：pet info, per store endpoint, pet data, REST API
ステップ6：カスタムメタデータを挿入する（高度なオプション）
高度なSEO制御のために、JSONを使用してカスタムメタタグを定義できます。
例：
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]これらはHTML内で標準的な<meta>タグとしてレンダリングされ、インデックス制御やソーシャルメディアで共有された際のページの表示方法を制御できます。
ApidogでのサイトレベルSEO設定のセットアップ
単一ページのSEO設定に加えて、Apidogはドキュメントサイト全体のメタデータ、インデックスルール、URLリダイレクトを管理するのに役立つ包括的なサイトレベルSEO構成を提供します。
これらの設定は、ドキュメントを公開する際に以下からアクセスできます。
Share Docs → Publish Docs Sites → SEO Settings
1. グローバルメタデータを構成する
Global Metadataを使用して、すべてのドキュメントページに適用されるメタタグを定義します。これにより、一貫したブランディングが確保され、各ページで作業を繰り返すことなくSEOが向上します。グローバルメタデータは次のように設定できます。
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]以下のような組み込み変数を使用できます。
{{PAGE_TITLE}}{{PAGE_URL}}{{SITE_NAME}}{{SITE_ICON}}{{DESCRIPTION}}{{KEYWORDS}}
⚠️ 優先順位ルール：ページレベルSEO設定はグローバルメタデータを上書きし、グローバルメタデータはシステムデフォルトを上書きします。
2. robots.txtを管理する
robots.txtファイルは、検索エンジンにどのページをクロールするかを指示します。Apidogは、すべてのクローラーがすべてのページにアクセスできるようにし、サイトマップファイルを指す基本的なrobots.txtを自動的に生成します。
特定のページがインデックスされないようにしたい場合は、グローバルメタデータまたはページレベルSEO設定に{"name": "robots", "content": "noindex"}を追加するだけです。
3. sitemap.xmlを有効または無効にする
sitemap.xml機能はSEOに非常に効果的なため、デフォルトで有効になっています。このファイル（「サイトマップ」とも呼ばれます）はサイトのディレクトリのようなもので、すべてのページのURLをリストアップします。検索エンジンのクローラーはこれを使用して、コンテンツを体系的かつ効率的にインデックスします。有効にすると、https://{your-domain.com}/sitemap.xmlでアクセスできます。
この機能を無効にする必要がある場合、システムはサイトマップの生成を停止し、robots.txtを自動的に更新してサイトマップへの参照を削除します。
4. 404エラーを回避するためのドキュメントリダイレクトルールを設定する
公開済みドキュメントのURLを変更する場合（例えばSEO最適化のため）、Docs Redirect Rulesを使用してトラフィックと検索エンジンランキングを維持します。リダイレクトルールを設定することで、古いURLにアクセスしたユーザーは自動的に新しいURLに送られます。
リダイレクトの設定方法：
1. SEO設定パネルのDocs Redirect Rulesセクションに移動します。
2. 古いURLと新しいURLを指定するルールを追加します。
これにより、ユーザーと検索エンジンの両方が404エラーに遭遇することなく、自動的に正しいページに送られるようになります。
ApidogでのURL命名戦略
URL設定では、カスタムURLを設定するかどうかに応じて、システムは異なる戦略を使用します。設定した場合、システムはあなたの値を直接使用します。例えば、api-overviewに設定すると、最終的なアドレスはhttps://{your-domain.com}/api-overviewとなります。
カスタムURLを設定しない場合、2つの自動生成ルールがあります。
- ルール1：タイトル + ID。例：
https://{your-domain.com}/SEO-Settings-5702007m0。これはセマンティック情報と一意性を組み合わせたもので、検索エンジンとユーザーの両方がページを理解するのに役立ちます。 - ルール2：IDのみ。例：
https://{your-domain.com}/5702007m0。これはよりシンプルですが、説明性は劣ります。
SEOの観点からは、URLにキーワードを使用することが一般的に良い選択です。検索エンジンはページのランキング付けにおいてURLキーワードを考慮します。とはいえ、ドキュメントサイトがすでに強力なドメインオーソリティを持っている場合は、キーワードが豊富な「セマンティック」URLの使用はそれほど重要ではなくなります。
ほとんどのウェブサイトでは、URLにキーワードを含めることがベストプラクティスです。ただし、よりクリーンなURLを好む場合や、ドキュメント構造が複雑な場合は、簡略化されたURLやシステム生成されたURLを使用することも有効な選択肢です。
APIドキュメントSEO構成の実践的なヒント
APIドキュメントを検索結果でより目立たせるために、これらのステップバイステップのSEOベストプラクティスに従ってください。
1. グローバルSEO設定から始める
まず、デフォルトのメタタイトル、ディスクリプション、キーワードなどのグローバルメタデータを設定することから始めます。これにより、ドキュメントサイト全体に一貫したSEO基盤が構築され、すべてのページが基本的な要素を網羅していることを保証します。
2. ページレベルSEOのために重要なページを優先する
次に、頻繁に使用されるエンドポイント、オンボーディングガイド、クイックスタートチュートリアルなど、最も重要なページを特定します。これらは、最も多くのトラフィックを誘導したいページです。
それぞれのページについて、以下をカスタマイズします。
- メタタイトル：明確でキーワードを豊富に含めるようにします。
- メタディスクリプション：ページコンテンツを簡潔に要約します。
- キーワード：ユーザーが検索しそうな関連用語を追加します。
3. 適切なURL構造を選択する
URLルールを設定する際は：
- チームがSEOを重視し、発見可能性を高めたい場合は、タイトルを含むURL（例：
/get-user-data）を使用します。 - シンプルさを好む場合や、複雑なドキュメント構造を持つ場合は、IDのみのURL（例：
/123456abc）を使用します。
4. SEOは長期的な取り組みであることを理解する
完璧なオンページ設定を行ったとしても、SEOには時間がかかります。検索ランキングは以下に依存します。
- サイトのドメインオーソリティ
- 他の信頼できるソースからのバックリンク
- ユーザーエンゲージメントと行動
- 検索エンジンによるクロール頻度
すぐに結果を期待しないでください。忍耐強く取り組みましょう。
5. データに基づいて継続的に改善する
定期的にSEOパフォーマンスを監視します。
- どのページがトラフィックを獲得しているか、どのページが獲得していないかを確認します。
- ユーザーからのフィードバックを収集します。
- 弱いページを、より明確なコンテンツとより良いメタデータで更新します。
結論
Apidogは、APIドキュメントが検索エンジンでより上位にランク付けされるのを助ける包括的なSEOツールキットを提供します。個々のページを詳細に調整することも、サイト全体のSEO設定を管理することも、すべて一箇所で行えます。
主な機能は以下の通りです。
- よりクリーンでキーワードが豊富なリンクのためのカスタムURL
- 検索可視性を向上させるためのメタタイトルとディスクリプション
- 検索エンジンがサイトをクロールするのを助けるためのサイトマップ生成
- SEO価値を失うことなくコンテンツ更新を管理するためのリダイレクトルール
小さなページレベルの編集を行う場合でも、グローバル設定を構成する場合でも、Apidogにはドキュメントを検索向けに最適化するために必要なすべてが揃っています。
詳細については、ApidogのヘルプドキュメントにあるSEO設定セクションを参照してください。
検索エンジン最適化についてさらに学びたい場合は、以下を参照してください。