#580
記事のバックリンクをAPIから取得できるようになりました
#580

Public 記事のバックリンクをAPIから取得できるようになりました

最終更新: 2026-05-21 12:09

今回のリリース内容

esa の Web UI ではすでに「バックリンク」 (旧: Referenced from) として記事下部に表示されていた、 「この記事をリンクしている他の記事」 の情報を、 API からも取得できるようになりました。

これにより、 API経由でも記事同士の参照関係を活用できるようになります。

1. 記事詳細 API のレスポンスに backlinks_count を追加し、 ?include=backlinks でバックリンク一覧も取得可能に

GET /v1/teams/:team_name/posts/:post_number (記事詳細 API) のレスポンスに、 バックリンクの総数 (backlinks_count) が含まれるようになりました。

GET /v1/teams/docs/posts/578

レスポンス例 (抜粋):

jsonc
{
  "number": 578,
  "name": "バックリンク",
  "backlinks_count": 3
  // ... その他のフィールド
}

加えて、 ?include=backlinks を指定すると、 バックリンク記事の軽量サマリの配列 (backlinks、 最大 15 件) もレスポンスに同梱されます。

GET /v1/teams/docs/posts/578?include=backlinks

レスポンス例 (抜粋):

json
{
  "number": 578,
  "name": "バックリンク",
  "backlinks_count": 3,
  "backlinks": [
    {
      "number": 577,
      "name": "リンク元の記事の表記を「Referenced from」から「バックリンク」に変更しました",
      "full_name": "ReleaseNotes/2026/05/07/...",
      "wip": false,
      "category": "ReleaseNotes/2026/05/07",
      "tags": [],
      "url": "https://docs.esa.io/posts/577",
      "created_at": "2026-05-07T10:36:41+09:00",
      "updated_at": "2026-05-07T11:51:14+09:00"
    }
    // ... 最大 15 件
  ]
}
  • バックリンクの並びは Web UI と同じく新しい順 (参照関係が作成された降順) です
  • backlinks_count が返却されるのは記事詳細 API のみです。 記事一覧 API (GET /v1/teams/:team_name/posts) や記事作成・更新系 API のレスポンスには含まれません
  • backlinks_count は同梱配列の件数ではなく、 その記事を参照しているチーム全体の記事数 を返します。 上限 15 件を超える場合は、 次の専用エンドポイントをご利用ください

2. バックリンク取得専用エンドポイントを追加

「16 件以上ある場合に全件取得したい」 「ページング処理したい」 といったユースケース向けに、 専用エンドポイントを新設しました。

GET /v1/teams/:team_name/posts/:post_number/backlinks?page=1&per_page=20

レスポンス例 (抜粋):

json
{
  "posts": [
    {
      "number": 577,
      "name": "リンク元の記事の表記を「Referenced from」から「バックリンク」に変更しました",
      "full_name": "ReleaseNotes/2026/05/07/...",
      "wip": false,
      "category": "ReleaseNotes/2026/05/07",
      "tags": [],
      "url": "https://docs.esa.io/posts/577",
      "created_at": "2026-05-07T10:36:41+09:00",
      "updated_at": "2026-05-07T11:51:14+09:00"
    }
    // ... 1 ページあたり最大 per_page 件
  ],
  "prev_page": null,
  "next_page": null,
  "total_count": 3,
  "page": 1,
  "per_page": 20,
  "max_per_page": 100
}
  • page / per_page でページネーションが可能 (他の一覧系 API と同様です)
  • レスポンスにはバックリンク記事の軽量サマリの配列に加え、 prev_page / next_page / total_count / page / per_page / max_per_page のメタ情報が含まれます

(\( ⁰⊖⁰)/) ヒトコト

esa を MCP / AI エージェント経由で活用される方が増えてきており、 「この記事はどこから参照されているか」 という情報の重要性が増していると感じています。 バックリンク情報がAPI 経由でも取得できるようになったので、 関連情報の自動収集や記事整理ツールなどで活用していただけると嬉しいです。

なお、 順参照 (記事が参照している先の記事一覧) や検索 API での 「参照あり/参照なし」 フィルタなどは未対応ですので、 ご要望ありましたらお気軽にお知らせください。


[ProTip] Webhookでdocs.esa.ioの更新通知を受け取ることができます

Enjoy "(\( ⁰⊖⁰)/)"
https://esa.io

Comments0