メインコンテンツまでスキップ

SEO設定

ApidogはAPI仕様書(ドキュメント)のSEO機能を提供しており、API仕様書(ドキュメント)を検索エンジンに最適化し、より多くのトラフィックを引き付けることができます。

Apidogバージョン >= 2.6.25 が必要です。

ApidogでのAPI仕様書(ドキュメント)またはMarkdownページの右側にあるSEO設定アイコンをクリックすることで、SEO設定にアクセスできます。

SEO設定ボタン

URL Slug

API、Markdownドキュメント、フォルダーにカスタムURLスラッグを作成することで、より検索エンジンに優しい構造にできます。スラッグが設定されると、共有APIドキュメント内のページのURLは次のように表示されます:https://your-domain.com/{slug}。

SEO設定情報を入力

ヒント

ご案内: 公開されたドキュメントにカスタムドメインを設定している場合、設定のURL Slugはその指定されたドメインとして表示されます。

メタデータ(Meta Data)

API仕様書(ドキュメント)の検索エンジンでの可視性を向上させるために、次のフィールドを設定できます:

タイトル:検索エンジン結果に表示されるウェブページのタイトル。

説明:検索エンジン結果に表示されるウェブページの簡単な説明。

キーワード(Keywords):ウェブページの検索エンジンランキングを向上させる対象キーワード。

メタソーシャル(Meta Social)

ウェブページをソーシャルメディアで共有する際、次のオプションを使ってカードスタイルをカスタマイズし、外観を向上させることができます。この機能は現在、TwitterとFacebookで利用可能です。

画像: ソーシャルメディアでウェブページと共に表示される画像を選択します。

タイトル: ソーシャルメディアでウェブページが共有されたときに表示されるタイトルを定義します。

説明: ソーシャルメディアで表示されるウェブページの簡潔な説明を提供します。

メタソーシャル

URL ルール

API仕様書(ドキュメント)の「公開設定」ページで、現在のURLルールを確認するために「プロジェクト設定」にアクセスできます。

プロジェクト設定にアクセス

クリックすると、URL の規則 ページに移動し、関連するルールをカスタマイズできます。

URL の規則 ページに移動

Note
  • 新しく公開されたドキュメントについては、URLルールが変更されると、システムが自動的にリダイレクトを適用します。
  • 既存のデータの場合、resourceKeyの仕様が変更されると、システムが自動的にリダイレクトを適用します。

システムがリダイレクトを自動で管理するため、ここで設定したルールは「ドキュメント公開 -> 公開設定 -> ドキュメントリダイレクトルール」テーブルには表示されません。

ドキュメントリダイレクトルール

ドキュメント内の既存のスラッグを変更する必要がある場合、リダイレクトルールを設定することで、ユーザーが正しいドキュメントにアクセスできるようになり、リンク切れを回避できます。

ドキュメントリダイレクトルールにアクセス

ドキュメント公開設定ページで、複数のリダイレクトルールを設定できます。ユーザーが古いSlugにアクセスすると、システムは自動的に新しいSlugにリダイレクトします。

新ダイレクトルール