API SEO設定

ApidogはAPIドキュメント向けにSEO機能を提供しており、検索エンジン最適化を行い、より多くのトラフィックを集めることができます。

Apidogバージョン2.6.25以上が必要です。

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

URL Slug

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

注意

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

APIドキュメントの検索エンジンでの可視性を向上させるために、以下のフィールドを設定できます。

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

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

キーワード: ウェブページの検索エンジンランキングを向上させるためのターゲットキーワード。

ウェブページをソーシャルメディアで共有する際、カードスタイルをカスタマイズして見た目を向上させることができます。現在、TwitterとFacebookで利用可能です。

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

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

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

APIドキュメント公開設定ページで、プロジェクト設定にアクセスし、現在のURLルールを確認できます。

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

注意

新しく公開されたドキュメントの場合、URLルールが変更されるとシステムは自動的にリダイレクトを適用します。

既存のデータの場合、resourceKeyの仕様が変更されるとシステムは自動的にリダイレクトを適用します。

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

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

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