こんにちは、takuyaです。最近、自分が作ったAPI文書が全然検索エンジンに引っかからなくて困っていました。いくら内容を丁寧に書いても、Googleで関連キーワードを検索しても自分の文書が出てこない...これって結構ショックですよね。
実は問題は内容ではなく、SEO対策が不十分だったんです。今回はApidogを使って、API文書のSEO設定を徹底的に最適化する方法を紹介します。個人的に試してみて、検索順位がかなり上がったので、同じ悩みを持つ方の参考になればと思います。
Apidogとは？
Apidogは、API設計・テスト・ドキュメント作成を統合したプラットフォームで、特にMCPサーバー機能を活用することで、AIコーディングアシスタントのトークン消費を大幅に削減できます。
主な特長：
- API設計からテスト、ドキュメント作成までをシームレスに実行
- 業界標準フォーマット（OpenAPI/Swagger/Postman）との互換性
- チームコラボレーション機能による開発プロセスの効率化
- AIコーディングアシスタントとの連携による開発速度の向上
Apidogのデフォルト最適化機能
まず知っておくべきなのは、Apidogで公開するオンラインドキュメントには、デフォルトでいくつかのSEO対策が施されています。具体的には：
- サイトマップ（sitemap）の自動生成
- robots.txtファイルの管理
- 意味のあるURL構造
- ページごとにカスタマイズ可能なメタデータタグ
これらは検索エンジンがサイトをクロールしてインデックスする際に非常に重要な要素です。でも、ここからさらに細かく設定することで、検索結果での表示順位を大幅に改善できるんですよ。
ページレベルのSEO設定から始めよう
Apidogでは、個別のページレベルとサイト全体レベルの2つのレイヤーでSEO設定ができます。まずは個別ページの設定から見ていきましょう。
任意のAPI文書やMarkdownページの右上に「SEO設定」アイコンがあります。これをクリックすると設定パネルが開きます。正直、最初は「こんな細かい設定、必要かな？」と思っていましたが、実際に設定してみると効果は絶大でした。
カスタムURLの設定
最も基本的なのはカスタムURL機能です。システムがデフォルトで生成するURLには数字の羅列が含まれていて、例えば https://{your-domain.com}/5702007m0 のようになります。これじゃあ何のページか全然わかりませんよね。
例えば「ペット情報取得」APIのURLを get-pet-info-by-id に設定すると、最終的なURLは https://{your-domain.com}/get-pet-info-by-id になります。一目で機能がわかるので、ユーザーにとっても検索エンジンにとっても親切です。
メタタイトルとメタディスクリプション
Meta TitleとMeta Descriptionの設定も重要です。Meta Titleは検索結果に表示される青いタイトル部分で、検索ランキングとクリック率に直接影響します。
個人的には、タイトルには必ず主要キーワードを入れるようにしています。例えば「Apidog - ペット情報取得API仕様書」のように。これだけでも検索順位が変わってきますよ。
Meta Descriptionはページの説明文で、検索エンジンがこれを検索結果に表示することもあります。ここにも重要なキーワードを自然な形で入れておくと効果的です。
キーワードとカスタムメタデータ
Keywordsの設定も忘れずに。最近の検索エンジンはkeywordsへの依存度は下がっていますが、ページのテーマ理解には役立ちます。「ペット情報取得」APIなら「ペット情報、API、REST API、データ取得」などが良いでしょう。
より高度なSEOニーズがある場合は、「カスタムMetadata」機能を使って任意のmetaタグを追加できます。JSON形式で設定するので、最初は少し戸惑いましたが、慣れると非常に便利です。例えば：
{"name": "robots", "content": "noindex"}
これで特定のページを検索エンジンのインデックスから除外できます。また：
{"property": "og:image", "content": "画像リンク"}
これでSNSでシェアされたときのサムネイル画像を設定できます。
サイト全体のSEO設定
個別ページの設定が終わったら、次はサイト全体の設定です。オンラインドキュメントを公開する際に「SEO設定」モジュールから管理できます。
グローバルメタデータの設定
グローバルMetadataは最も重要な機能の一つです。サイト全体に適用される共通のmetaタグを設定でき、すべてのページがこれらの設定を継承します。さらに、内部変数をサポートしているので、ページごとに同じ情報を繰り返し入力する必要がありません。
例えば：
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]
ここで {{PAGE_TITLE}} と {{SITE_NAME}} は実際のページタイトルとサイト名に自動的に置き換えられます。これは本当に便利で、一度設定すれば後は自動的に最適なメタデータが生成されるんです。
設定には優先順位があります：ページレベルの設定 > グローバル設定 > システムデフォルト値。この階層構造のおかげで、柔軟性を保ちながら設定の衝突を避けられます。
robots.txtとsitemap.xmlの管理
robots.txtファイルの管理も簡単です。このファイルは検索エンジンのクローラーに対する指示書のようなもので、どのページをクロールしてよいかを伝えます。Apidogは基本的なrobots.txtを自動生成し、すべてのクローラーがすべてのページにアクセスできるようにし、sitemapファイルの場所も指定します。
sitemap.xml機能はデフォルトで有効になっています。これはSEOに非常に役立つからです。このファイルはサイトの目次のようなもので、すべてのページのアドレスをリストアップします。検索エンジンのクローラーはこの目次があれば、より体系的かつ効率的にコンテンツをクロールできます。有効にすると、https://{your-domain.com}/sitemap.xml からアクセスできます。
リダイレクトルールの設定
公開済みドキュメントのURLを変更する必要がある場合、「ドキュメントリダイレクトルール」機能が役立ちます。例えばドキュメントのアドレスを変更したり、アドレス構造を最適化したりする場合、URLを直接変更すると、ユーザーが古いアドレスにアクセスした際に404エラーが表示されてしまいます。
リダイレクトルールを設定することで、古いアドレスにアクセスしたユーザーを自動的に新しいアドレスにリダイレクトできます。これによりユーザー体験を保ちながら、SEO評価の低下も防げます。個人的には、URLを変更する際は必ずリダイレクトを設定するようにしています。
URL命名の2つの戦略
URLの設定に関しては、カスタムURLを設定したかどうかによって、システムは異なる戦略を採用します。カスタムURLを設定した場合、システムはその値を直接使用します。例えば api-overview と設定すると、最終的なアドレスは https://{your-domain.com}/api-overview になります。
カスタムURLを設定していない場合、システムは2つの自動生成ルールを提供します：
-
タイトルとIDの組み合わせ：例えば
https://{your-domain.com}/SEO-設定-5702007m0。この方法は意味情報を含みつつ、一意性も確保します。 -
IDのみ：例えば
https://{your-domain.com}/5702007m0。よりシンプルですが、意味情報が欠けています。
SEOの観点からは、最初の方法が有利です。なぜなら検索エンジンはURLのキーワードをランキング要素の一つとして使用するからです。ただし、ドキュメントサイトの権威性や知名度が十分に高い場合は、URLの意味性の重要性は相対的に低くなります。
私の経験では、ほとんどのドキュメントサイトでは、キーワードを含むURLを選択する方が良いでしょう。シンプルさを重視する場合や、ドキュメント構造が複雑な場合は、2番目の方法も合理的な選択です。
実践的な設定アドバイス
実際の運用では、まずグローバル設定から始めることをお勧めします。グローバルMetadataを設定し、ドキュメントサイト全体のSEO基盤を構築します。この手順が完了すれば、すべてのページに基本的なSEO設定が適用されます。
その後、特にトラフィックを獲得したい重要なページに焦点を当てます。例えば、最もよく使われるAPIインターフェースや、新規ユーザーが最初に触れるクイックスタートドキュメントなどです。これらのページには個別にページレベルの最適化を行い、より正確なタイトル、説明、キーワードを設定します。
URLルールの選択については、チームがSEO効果を重視する場合は、タイトルを含むURLルールを選択することをお勧めします。シンプルさを重視する場合は、IDのみのルールを選択できます。
注意すべき点として、SEOは長期的なプロセスであり、設定後すぐに効果が現れることを期待しないでください。検索エンジンのランキングはページ自体の最適化だけでなく、サイト全体の権威性、他のサイトからのリンク（バックリンク）、ユーザーの行動データなど、多くの要因に影響されます。
私の場合、ページレベルとサイトレベルの両方でSEOを最適化しても、検索エンジンが変更を認識し、評価するまでに約1ヶ月かかりました。根気強く待つことが大切です。
まとめ
Apidogの完全なSEO機能を活用することで、API文書が検索エンジンでより良い結果を得られるようになります。ページレベルの細かい最適化からサイトレベルの統合管理まで、カスタムURLからメタデータ設定、サイトマップ生成からリダイレクトルールまで、これらの機能はドキュメントサイトのSEOのあらゆる側面をカバーしています。
個人的には、これらの設定を行った後、自分のAPI文書の検索順位が大幅に向上し、ユーザーからのフィードバックも増えました。特にカスタムURLとメタタイトルの最適化が効果的だったと感じています。
より詳細な情報については、ApidogのヘルプドキュメントのSEO設定モジュールを参照してください。また、検索エンジン最適化についてさらに学びたい方は、以下のリソースがおすすめです：
最後に、皆さんのAPI文書SEO設定の経験や質問があれば、ぜひコメント欄で共有してください。一緒に学び、成長していきましょう！