SEO設定

Apidogバージョン2.7.15以降が必要です。

Apidogは強力なSEO機能を提供し、APIドキュメントが検索エンジンでどのように表示されるかを最適化し、より多くのトラフィックを引き寄せるのに役立ちます。実際のニーズに基づいて、ページレベルまたはサイト全体レベルでSEO設定を構成できます。

ページレベルのSEO設定: APIドキュメントやMarkdownファイルなど、個々のページに対してSEOを設定します。
サイト全体レベルのSEO設定: ドキュメントサイト全体に対して、グローバルなSEOメタデータ、robots.txt、sitemap.xml、リダイレクトルール、URL設定を構成します。

ページレベルのSEO設定

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

ポップアウトパネルで以下を設定できます：

URL Slug: 現在のページのパスを定義します。例えば、find-by-idに設定すると、最終的なページURLはhttps://{your-domain.com}/find-by-idになります。

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

Meta Description（メタディスクリプション）: 検索エンジンの結果に表示されるウェブページの簡単な説明。

Keywords（キーワード）: 検索エンジンの理解を助けるキーワード。

Custom Metadata（カスタムメタデータ）: JSON形式で追加の<meta>タグを追加します。例：

[
  {"name": "robots", "content": "noindex"},
  {"name": "twitter:card", "content": "summary_large_image"}
]

これらはHTMLで次のようにレンダリングされます：

サイト全体レベルのSEO設定

オンラインドキュメントサイトを公開する際に、"SEO設定"に移動してサイト全体のSEO設定を適用します。

グローバルMetadata

これは、ドキュメントサイト内のすべてのページに対するデフォルトの<meta>タグを設定します。組み込み変数を使用して動的コンテンツを生成できます。すべてのページは、ページレベルのSEO設定で上書きされない限り、この設定を継承します。

設定形式:

有効なJSON配列を使用してください。例：

[
  {"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"},
  {"property": "og:description", "content": "{{DESCRIPTION}}"},
  {"property": "og:image", "content": "{{SITE_ICON}}"},
  {"name": "twitter:card", "content": "summary_large_image"},
  {"name": "description", "content": "global description information"},
  {"name": "keywords", "content": "global keywords"}
]

これらはHTMLで次のようにレンダリングされます：

サポートされている組み込み変数:

以下の組み込み変数がサポートされており、コンテンツフィールドにプレースホルダーとして使用できます：

変数	意味
`{{PAGE_TITLE}}`	現在のページのタイトル
`{{PAGE_URL}}`	ページの完全なURL
`{{SITE_NAME}}`	ドキュメントサイトの名前
`{{SITE_ICON}}`	サイトアイコンのURL
`{{DESCRIPTION}}`	デフォルトのページ説明
`{{KEYWORDS}}`	デフォルトのページキーワード

優先順位:

ページレベルのSEO設定(APIまたはMarkdownページ) > グローバルメタデータ > システムデフォルト

Robotsファイル(robots.txt)

このファイルはクローラーの動作を制御し、https://{your-domain.com}/robots.txtでアクセス可能です。

デフォルトの内容:

User-Agent: *
Allow: /

Sitemap: {{SITEMAP_URL}}

{{SITEMAP_URL}}は、サイトマップ機能が有効な場合、実際のsitemap.xmlURLに自動的に置き換えられます。

無効な場合、この行は自動的に削除されます。

ページがインデックスされないようにする方法:

サイト全体のインデックスをブロックする

グローバルメタデータに以下を追加します：

{"name": "robots", "content": "noindex"}

単一ページのインデックスをブロックする

特定のページのカスタムメタデータに以下を追加します：

{"name": "robots", "content": "noindex"}

Sitemapファイル(sitemap.xml)

有効にすると、システムはサイト上のすべてのページをリストするsitemap.xmlを自動生成し、検索エンジンがより効果的にクロールできるようにします。Sitemapはhttps://{your-domain.com}/sitemap.xmlでアクセスできます。

デフォルトの状態: 有効。

無効にすると、sitemap.xmlは利用できなくなり、robots.txtからもSitemap: {{SITEMAP_URL}}が削除されます。

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

公開されたドキュメントのURLを変更した場合、ユーザーが古いURLにアクセスした際に404エラーを避けるためにリダイレクトルールを設定できます。

複数のリダイレクトルールを手動で追加し、ユーザーを古いURLから新しいURLに自動的に転送できます：

URL & Slug規則

プロジェクト設定をクリックして、サイトページのデフォルトのURLルールを表示します。

ページにカスタムSlug(URL)が設定されているかどうかに応じて、2種類のURL命名ルールがあります。

URL Slugが設定されている場合

システムは提供されたSlugをアクセスパスとして使用します：

例えば、MarkdownファイルのSlugがapi-overviewの場合、アドレスは次のようになります：

URL Slugが空白の場合

チームのSEOの好みやドキュメントワークフローに最適なルールを選択してください。

共通メタデータリファレンス

[
  {
    "name": "robots",
    "content": "noindex"
  },
  {
    "name": "charset",
    "content": "UTF-8"
  },
  {
    "name": "viewport",
    "content": "width=device-width, initial-scale=1.0"
  },
  {
    "name": "description",
    "content": "Page description"
  },
  {
    "name": "keywords",
    "content": "keyword1, keyword2, keyword3"
  },
  {
    "name": "author",
    "content": "Author Name"
  },
  {
    "name": "googlebot",
    "content": "index, follow"
  },
  {
    "name": "google",
    "content": "notranslate"
  },
  {
    "name": "google-site-verification",
    "content": "verification_token"
  },
  {
    "name": "generator",
    "content": "Mintlify"
  },
  {
    "name": "theme-color",
    "content": "#000000"
  },
  {
    "name": "color-scheme",
    "content": "light dark"
  },
  {
    "name": "format-detection",
    "content": "telephone=no"
  },
  {
    "name": "referrer",
    "content": "origin"
  },
  {
    "name": "refresh",
    "content": "30"
  },
  {
    "name": "rating",
    "content": "general"
  },
  {
    "name": "revisit-after",
    "content": "7 days"
  },
  {
    "name": "language",
    "content": "en"
  },
  {
    "name": "copyright",
    "content": "Copyright 2024"
  },
  {
    "name": "reply-to",
    "content": "email@example.com"
  },
  {
    "name": "distribution",
    "content": "global"
  },
  {
    "name": "coverage",
    "content": "Worldwide"
  },
  {
    "name": "category",
    "content": "Technology"
  },
  {
    "name": "target",
    "content": "all"
  },
  {
    "name": "HandheldFriendly",
    "content": "True"
  },
  {
    "name": "MobileOptimized",
    "content": "320"
  },
  {
    "name": "apple-mobile-web-app-capable",
    "content": "yes"
  },
  {
    "name": "apple-mobile-web-app-status-bar-style",
    "content": "black"
  },
  {
    "name": "apple-mobile-web-app-title",
    "content": "App Title"
  },
  {
    "name": "application-name",
    "content": "App Name"
  },
  {
    "name": "msapplication-TileColor",
    "content": "#000000"
  },
  {
    "name": "msapplication-TileImage",
    "content": "path/to/tile.png"
  },
  {
    "name": "msapplication-config",
    "content": "path/to/browserconfig.xml"
  },
  {
    "name": "og:title",
    "content": "Open Graph Title"
  },
  {
    "name": "og:type",
    "content": "website"
  },
  {
    "name": "og:url",
    "content": "https://example.com"
  },
  {
    "name": "og:image",
    "content": "https://example.com/image.jpg"
  },
  {
    "name": "og:description",
    "content": "Open Graph Description"
  },
  {
    "name": "og:site_name",
    "content": "Site Name"
  },
  {
    "name": "og:locale",
    "content": "en_US"
  },
  {
    "name": "og:video",
    "content": "https://example.com/video.mp4"
  },
  {
    "name": "og:audio",
    "content": "https://example.com/audio.mp3"
  },
  {
    "name": "twitter:card",
    "content": "summary"
  },
  {
    "name": "twitter:site",
    "content": "@username"
  },
  {
    "name": "twitter:creator",
    "content": "@username"
  },
  {
    "name": "twitter:title",
    "content": "Twitter Title"
  },
  {
    "name": "twitter:description",
    "content": "Twitter Description"
  },
  {
    "name": "twitter:image",
    "content": "https://example.com/image.jpg"
  },
  {
    "name": "twitter:image:alt",
    "content": "Image Description"
  },
  {
    "name": "twitter:player",
    "content": "https://example.com/player"
  },
  {
    "name": "twitter:player:width",
    "content": "480"
  },
  {
    "name": "twitter:player:height",
    "content": "480"
  },
  {
    "name": "twitter:app:name:iphone",
    "content": "App Name"
  },
  {
    "name": "twitter:app:id:iphone",
    "content": "12345"
  },
  {
    "name": "twitter:app:url:iphone",
    "content": "app://"
  },
  {
    "name": "article:published_time",
    "content": "2024-01-01T00:00:00+00:00"
  },
  {
    "name": "article:modified_time",
    "content": "2024-01-02T00:00:00+00:00"
  },
  {
    "name": "article:expiration_time",
    "content": "2024-12-31T00:00:00+00:00"
  },
  {
    "name": "article:author",
    "content": "Author Name"
  },
  {
    "name": "article:section",
    "content": "Technology"
  },
  {
    "name": "article:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "book:author",
    "content": "Author Name"
  },
  {
    "name": "book:isbn",
    "content": "1234567890"
  },
  {
    "name": "book:release_date",
    "content": "2024-01-01"
  },
  {
    "name": "book:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "profile:first_name",
    "content": "John"
  },
  {
    "name": "profile:last_name",
    "content": "Doe"
  },
  {
    "name": "profile:username",
    "content": "johndoe"
  },
  {
    "name": "profile:gender",
    "content": "male"
  },
  {
    "name": "music:duration",
    "content": "205"
  },
  {
    "name": "music:album",
    "content": "Album Name"
  },
  {
    "name": "music:album:disc",
    "content": "1"
  },
  {
    "name": "music:album:track",
    "content": "1"
  },
  {
    "name": "music:musician",
    "content": "Artist Name"
  },
  {
    "name": "music:song",
    "content": "Song Name"
  },
  {
    "name": "music:song:disc",
    "content": "1"
  },
  {
    "name": "music:song:track",
    "content": "1"
  },
  {
    "name": "video:actor",
    "content": "Actor Name"
  },
  {
    "name": "video:actor:role",
    "content": "Role Name"
  },
  {
    "name": "video:director",
    "content": "Director Name"
  },
  {
    "name": "video:writer",
    "content": "Writer Name"
  },
  {
    "name": "video:duration",
    "content": "120"
  },
  {
    "name": "video:release_date",
    "content": "2024-01-01"
  },
  {
    "name": "video:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "video:series",
    "content": "Series Name"
  }
]

ページレベルのSEO設定#

サイト全体レベルのSEO設定#

グローバルMetadata#

Robotsファイル(robots.txt)#

Sitemapファイル(sitemap.xml)#

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

URL & Slug規則#

共通メタデータリファレンス#

ページレベルのSEO設定

サイト全体レベルのSEO設定

グローバルMetadata

Robotsファイル(robots.txt)

Sitemapファイル(sitemap.xml)

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

URL & Slug規則

共通メタデータリファレンス