公開した記事だけをRSSで配信する

公開記事のタイトルと要約からRSSを作り、下書きを含めずXMLとして返します。

目次

RSSは、新しい記事の情報を購読用アプリに渡すためのデータです。ここでは公開記事のタイトル、URL、要約を1つのURLにまとめます。購読者へのメール送信は行いません。

先に用意するもの

写真付き一覧のガイドの「練習用サイトを準備する」まで済ませてください。同じダウンロード教材「週末ノート」を使います。EmDash 1.4.0、Astro 7.4.5、Node.js 24.22.1が対象です。実行確認はmacOSで行いました。Windows向けの入力例はコマンドプロンプト用で、Windows実機では未確認です。

以下のファイル名は、特に断りがなければ教材の weekend-note フォルダーからの場所です。ファイルの内容はVS Codeで編集し、指定された名前で保存します。コマンドはファイルに保存せず、コマンド入力画面へ貼り付けて実行します。どちらも、囲みの前にある説明で作業する場所を確認してください。開発サーバーは weekend-note のコマンド入力画面で npm run dev を実行しておきます。

起動に使った画面は開いたままにします。このあとのコマンドは、別の入力画面で実行します。VS Code左側のファイル一覧で weekend-note フォルダーを右クリックし、**Open in Integrated Terminal(統合ターミナルで開く)**を選ぶと、そのフォルダーを作業場所にした画面を開けます。Windowsでは、パソコンの準備で選んだコマンドプロンプトを使います。

1. RSS用のファイルを用意する

src/pages/rss.xml.ts を開きます。画面用の .astro ではなく、データを返す .ts のファイルです。次が全体です。

import type { APIRoute } from 'astro';
import { getEmDashCollection } from 'emdash';
function xml(value: string) {
  return value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&apos;');
}
export const GET: APIRoute = async ({ url }) => {
  const { entries, error } = await getEmDashCollection('posts', { limit: 20, orderBy: { published_at: 'desc' } });
  if (error) return new Response('RSSを作れませんでした。', { status: 500 });
  const items = entries.map(post => {
    const link = new URL(`/posts/${post.id}/`, url.origin).href;
    return `<item><title>${xml(post.data.title)}</title><link>${xml(link)}</link><guid>${xml(link)}</guid><description>${xml(post.data.excerpt ?? '')}</description></item>`;
  }).join('');
  return new Response(`<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"><channel><title>週末ノート</title><link>${xml(url.origin)}</link><description>休日の小さな発見</description><language>ja</language>${items}</channel></rss>`, { headers: { 'Content-Type': 'application/rss+xml; charset=utf-8' } });
};

GET は、このURLを開いたときに実行する処理です。Content-Type でRSSのXML形式だと伝えています。XMLは、<title> のような印で内容を区切る書き方です。

xml() は、文章中の & や < がXMLの記号と混ざらないように変換します。記事のタイトルをそのまま文字列へ入れず、この関数を通します。guid には各記事を区別するためのURLを入れています。

2. ブラウザーで内容を確かめる

http://127.0.0.1:4350/rss.xml を開きます。ブラウザーによって、文字やタグの一覧が表示されたり、ファイルとしてダウンロードされたりします。どちらも正常な表示です。ダウンロードされたらVS Codeで開いてください。

<item> が記事1件分です。初期データでは12件あり、「公開しない練習用の下書き」は含まれません。タイトルに & を入れた記事なら、XMLの中では &amp; になります。

この実習では取得件数を20件にしています。21本以上の記事があっても、新しい20本だけを出す構成です。全記事の書き出し機能とは用途が違います。

3. 実際の公開サイトへ持っていく前に

この例では、RSSを開いたURLのホスト名(ドメイン名やIPアドレス)を使って記事へのリンクを作ります。手元で試すと 127.0.0.1:4350 になります。公開するときは正式なサイトURLでRSSを開き、すべてのリンクが公開先を指していることを確認します。複数のドメインを使うサイトでは、正式なURLを設定から固定する方法も検討してください。

RSSを開けない場合はファイル名が rss.xml.ts かを確認します。500エラーの場合は記事の取得に失敗しています。0件の正常なRSSと混同せず、開発サーバーのログを見ます。

終了するとき・次回続けるとき

npm run devを実行した画面が入力待ちに戻っていなければ、その画面でControl + Cを押して停止します。入力待ちに戻ったあともサイトが動き続けている場合は、weekend-noteでnpx astro dev stopを実行します。次回は同じフォルダーでnpm run devを実行してください。初期データを入れるseedコマンドを繰り返す必要はありません。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。