HN 日本語サマリー

← 一覧へ戻る
Web開発

RSSフィードのベストプラクティス (2022年)

RSS Feed Best Practices (2022) (kevincox.ca)

55 pointsby KomoD10 コメント

要約

この記事は、ブログコンテンツの共有方法に関する技術的なベストプラクティスを解説しています。RSS 2またはAtom形式の使用を推奨し、特にAtomは互換性の問題が少なく、仕様も明確であるため、新規にフィードを作成する場合に推奨されています。フィードの提供形式は一つに絞り、Content-Typeヘッダーを正しく設定し、すべてのURLを絶対URLにすること、そしてHTMLの<link>タグやHTTPヘッダーでフィードの発見可能性を高めることが重要です。さらに、フィードはHTTPSで提供し、記事の全文を含めること、Entry IDは変更せず、公開日と最終更新日を正確に扱うことが推奨されています。

全文翻訳

RSSフィードのベストプラクティス

投稿日: 2022-05-06

最終更新日: 2024-03-13

これはブログを公開するための技術的なヒントです。良いコンテンツとは関係なく、コンテンツを共有する方法についてです。推奨事項は重要度のおおよその順に並んでおり、なぜそれが重要なのかという理由も添えられています。

フォーマット

一般的にフィードは「RSSフィード」と呼ばれますが、通常は具体的にRSSを指しているわけではありません。RSSは唯一の、あるいは最良のフォーマットでもありません。標準化されたフォーマットを使用することは、フィードが最も幅広い読者や検索エンジンに理解されるために不可欠です。

RSS 2 または Atom を使用すべきです。これらのフォーマットは非常に広くサポートされています。その他の一般的なフォーマットには、古いRSS規格やJSON Feed、Microformats h-feed などがあります。これら、あるいはさらに一般的でないフォーマットは、サポートが少ないため避けるべきです。

まだフィードがない場合は、Atomを強くお勧めします。仕様には曖昧さが少なく、使用されている多種多様なクライアントとの互換性の問題が発生する可能性が低くなります。仕様も全体的によりシンプルで明確です。すでにRSS 2フィードを持っている場合は、アップグレードする理由はほとんどありません。

最小限のAtomテンプレートを以下に示します。詳細については仕様を参照してください。例が必要な場合は、私のフィードをご覧ください。

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
	<title>{{FEED_NAME}}</title>
	<id>{{HOMEPAGE_URL}}</id>
	<link rel="alternate" href="{{HOMEPAGE_URL}}"/>
	<link rel="self" href="{{FEED_URL}}"/>
	<updated>{{LAST_UPDATE_TIME in RFC3339 format}}</updated>
	<author>
		<name>{{AUTHOR_NAME}}</name>
	</author>
	<entry>
		<title>{{ENTRY.TITLE}}</title>
		<link rel="alternate" type="text/html" href="{{ENTRY.HTML_URL}}"/>
		<id>{{ENTRY.PERMALINK}}</id>
		<published>{{ENTRY.FIRST_POST_TIME in RFC3339 format}}</published>
		<updated>{{ENTRY.LAST_UPDATE_TIME in RFC3339 format}}</updated>
		<content type="html">{{ENTRY.HTML}}</content>
	</entry>
</feed>

複数のフォーマットでフィードを提供する必要はほとんどありません。Atomフィードがある場合、RSSフィードを別途提供する必要はありません。

フィードフォーマットの変更は安全です。フィードがAtomとRSSの間で切り替わっても、混乱する読者はごくわずかです。これは、同じURLでフィードを変更するか、新しいURLにリダイレクトすることで行うことができます。(Content-Typeを更新することを忘れないでください)

Content Type

Content-Typeヘッダーを正しく設定してください。

  • Atom: Content-Type: application/atom+xml
  • RSS: Content-Type: application/rss+xml
  • JSON Feed: Content-Type: application/feed+json

実際には他の値も使われますが、これらが標準値であり、最も広くサポートされています。

絶対URL

フィード内のすべてのURLは絶対URLであるべきです。Atomは相対URLの解決方法を明確に指定していますが、正しく実装されることは稀です。フィードがすべての読者に理解されるようにするため、絶対URL(https://で始まるもの)のみを使用してください。

これには、すべての<link>要素、および投稿の要約と本文(HTML内を含む)が含まれます。

発見

ブログのすべてのページ、おそらくサイトのすべてのページに、フィードを宣伝するためのメタデータを記載すべきです。これにより、読者や検索エンジンが購読し、新しいコンテンツを認識できるようになります。これは、HTMLに以下を含めるだけで簡単です。

<link rel=alternate title="Blog Posts" type=application/atom+xml href="/feed.atom">

複数のフィードがある場合は、適切なタイトルを付けてすべて宣伝できます。

<link rel=alternate title="All Posts" type=application/atom+xml href="/feed.atom">
<link rel=alternate title='Posts in the "Social" category' type=application/atom+xml href="/feeds/social.atom">
<link rel=alternate title="Comments on this Post" type=application/atom+xml href="/post/hello-world/comments.atom">

フィードのtypeが正しいことを確認してください。提供されている例はAtomフィード用です。

「最も重要な」フィードを一番上に配置することを推奨します。多くのクライアントは、ユーザーにフィードを表示する際に順序を保持します。これは主観的ですが、通常はサイト全体のフィード、次にカテゴリフィード、そして特定のページのコメントフィードとなります。複数のフォーマットでフィードを提供する場合、1つだけを宣伝することをお勧めします(AtomまたはRSS 2のいずれか)。複数のフォーマットで同じコンテンツへのリンクを含めると、潜在的な購読者を混乱させたり、分析麻痺に陥らせたりする可能性があります。(コンテンツが同じであることをどうやって知るのでしょうか?)

W3C Feed Validation ServiceにウェブサイトのURLを入力することで、これが正しく機能しているか検証できます。リンクが正しく設定されていれば、フィードを検出し検証するはずです。いくつかの異なるページを試して、すべての場所で発見機能が機能していることを確認してください。ホームページ、投稿リストページ、個々の投稿ページを試してください。

HTMLの変更が難しい場合、HTTPレスポンスのLinkヘッダーを使用できます。ただし、これはあまり広くサポートされていません。HTML <link>タグを使用する方が、より広い互換性のために推奨されます。

Link: /feed.atom; rel="alternate"; type="application/atom+xml"

また、他のフィードインジケーターがないユーザーのために、RSSロゴの付いたリンク[画像: rss logo]を含めるべきです。

HTTPS

HTTPSは、インターネット上のセキュリティとプライバシーの鍵です。HTTPS経由でフィードを提供することで、ユーザーのプライバシーが保護され、フィードが悪意のあるアクターによって改ざんされないことが保証されます。

  1. 埋め込まれたメディア(画像など)はすべてHTTPSで参照してください。多くのリーダーは、HTTPリクエストが許可されないセキュアなコンテキストで実行されます。
  2. フィードをHTTPSで提供してください。
  3. セルフリンクがHTTPSであることを確認してください。
  4. HTTPリクエストをHTTPSにリダイレクトしてください。
  5. Strict-Transport-Securityの使用を検討してください。

フルコンテンツ

一般的に、投稿の完全なコンテンツをフィードで提供することが推奨されます。これがほとんどの読者が好む方法です。RSSとAtomの場合、<content>要素に記事全体を含めるべきです。Atomには、より短い要約を好む読者のために、<summary>要素もあります。

もちろん、一部の出版物では、これらのビューの収益化の難しさから、フィードで完全なコンテンツを共有することは受け入れられません。まず、完全なコンテンツをフィードリーダーで表示できないと、一部の読者が離脱する可能性があることを考慮してください。広告が表示されなくても、友人にコンテンツを共有したり、ニュースアグリゲーターに投稿したりするかもしれません。それでも、読者を失うよりは、その読者がいる方が価値がある可能性が高いです。

コンテンツが有料の場合、認証トークンを提供することで、ユーザーがプライベートリンクを生成できるようにすることを検討してください。例: /feed.atom?user=peruserauthtoken。また、ベーシック認証をhttps://fred:peruserauthtoken@blog.example/feed.atomのように使用することもできますが、これはURLパスやクエリ文字列にトークンを提供するよりも、サポートするリーダーが少ないです。

エントリID

エントリIDは、フィード内のエントリを識別し、区別するための主要な方法です。エントリIDが変更されたり、重複したりすると、読者は重複を受け取ったり、エントリを見逃したりします。

  1. 既存の記事のIDを変更しないでください。
    • IDスキームを変更する場合は、新しいエントリにのみ適用されるようにしてください。
  2. 異なる記事に同じエントリIDを再利用しないでください。
  3. エントリIDには、記事のパーマリンクを使用することを推奨します。
  4. 存在するすべてのフィード間で、エントリIDをグローバルに一意にすることをお勧めします。
    • 一部のリーダーはフィードをマージするため、一意のIDは問題が発生しないように役立ちます。
    • これを達成する最も簡単な方法は、自分が管理するドメインのURLを使用することです。それが不可能な場合は、UUID(例: urn:uuid:f4a3ca5b-5799-44e8-aaaa-e40728f037d3)を使用できます。

日付

AtomとRSSは、公開時間(エントリがフィードに最初に表示された時間)と最終更新時間(エントリが最後に変更された時間)を区別します。これらを正しく処理してください。

  1. 公開時間を含めてください。
  2. 公開時間は変更しないでください。エントリは一度しか公開できません。
  3. 公開時間は、エントリがフィードに表示された時期とほぼ一致するようにしてください。一部のリーダーは、はるか昔に公開されたエントリを無視する場合があります。
  4. エントリが公開時間の順序とは異なる順序でフィードに表示され始めることを強く避けてください。(例: 14:00に公開されたアイテムが14:00にフィードに表示され始め、その後13:00に公開されたアイテムが15:00にフィードに表示され始めるのを避けてください。一部のクライアントは、14:00のアイテムはすでに知っているが、「それより前の」13:00のアイテムはまだ知らないことに疑念を抱くでしょう。)これを別の見方で捉えると、フィードに表示される新しいアイテムはすべて、フィード内の以前のすべてのアイテムよりも後の公開時間を持つべきです。一部のクライアントは、たとえ公開時間がかなり最近であっても、これらの「過去の日付」のエントリを無視します。
  5. 未来の公開時間を避けてください。公開時間が未来すぎると、多くのリーダーはバグとして無視します。
  6. 更新時間は、公開時間以上であるべきです。新しいエントリでは、これら2つは同じであるべきです。
  7. 更新時間は、重要な更新でのみ変更してください。わずかなフォーマットの変更やタイプミスの修正は、通常、最終更新時間を変更すべきではありません。ほとんどのリーダーは更新時間を無視しますが、一部は記事を「更新済み」として再表示します。

フィードタイトル

フィードのタイトルは、ユーザーのリーダーでデフォルトで使用される可能性が高いです。多くのリーダーにはタイトルを上書きするオプションがありますが、これはユーザーにとって追加の作業であり、普遍的にサポートされているわけではありません。フィードの良いタイトルを選ぶようにしてください。

  1. コンテキストを含めてください。タイトルは、ユーザーのリーダーにある多くのフィードのうちの1つである可能性が高いです。例えば、「ブログ投稿」ではなく、「Kevin Coxのブログ」のように呼びます。
  2. 簡潔に保ってください。ユーザーはすでに購読しているので、さらに宣伝する必要はありません。例: 「John Smith」または「John Smithの写真ブログ」。「John Smith — 毎週火曜日と金曜日の写真に関するつぶやき、カメラ、フィルム、現像 — 限定コンテンツ」のようなものではありません。
  3. < > &のようなHTML特殊文字を避けてください。RSSでは、フィードタイトルに<b>タグのようなスタイリングを含めることができるかどうかは完全には明確ではありません。HTMLを解析するリーダーはごくわずかであり、ほとんどの場合タイトルを文字通り扱います。

フィードタイトルはいつでも更新できますが、頻繁に変更するとユーザーを混乱させる可能性があります。

スタイリング

フィードでCSSを使用しても構いません!ただし、多くのフィードリーダーは最新のブラウザエンジンを使用しておらず、レンダリングできるものに制限がある可能性があることに注意してください。さらに、多くのフィードリーダーはフィードをサニタイズするため、一般的でない要素やカスタムCSSは部分的に、または完全に削除される可能性があります。しかし、それに止まらないでください!HTMLとCSSを使用することで、優れたリーダーを持つユーザーのエクスペリエンスを大幅に向上させることができます。以下のヒントを検討してください。

  1. CSSが適用されない場合にどうなるかを考慮してください。例えば、background: black; color: whiteを設定し、どちらかのルールが削除された場合、読めないテキストになります。一般的に、CSSに大きく依存するのではなく、小さな調整を行うことを推奨します。
  2. 個別の<style>ブロックよりも、インラインCSS style属性を優先してください。これらはより広い互換性があります。
  3. <div>や<span>でスタイルを模倣するよりも、<p>、<h1>、<pre>、<code>のようなセマンティック要素を優先してください。
  4. JavaScriptに依存しないでください。ほとんどのリーダーはサポートしていません。
  5. <audio>、<video>、<iframe>タグのフォールバックを提供してください。サポートは一般的ではありません。
  6. フォーム要素や入力要素は避けてください。サポートは稀で互換性がありません。

残念ながら、何が機能するかを確認するために、さまざまなリーダーでテストすることに代わるものはありません。

セルフリンク

フィードのセルフリンクが正確であることを確認してください。

<link rel="self" href="https://kevincox.ca/feed.atom"/>

これにより、以下の利点があります。

  1. フィードの移動が可能になります。一部のリーダーは、フィードURLが変更された場合、リダイレクトターゲットにセルフリンクが含まれていればフィードURLを更新します。
  2. キャッシュヒット率の向上。ユーザーがフィードURLのわずかなバリエーションを見つけることはよくあります。例えば、http:ではなくhttps:、/feedと/feed/、www.example.comとexample.com、feed.atom?tracker=lookatmeや?category=rant&content=fullと?content=full&category=rantなどです。正規化されたセルフリンクを提供することで、これらのバリエーションをマージし、キャッシュヒット率を向上させることができます。
  3. WebSubに必要です。
  4. ユーザーがフィードファイルのコピーを持っている場合、それに購読できます。例えば、一部のフィードリーダーはフィードのファイルハンドラとして機能します。ファイルにセルフリンクが含まれている場合、そのURLを使用して購読し、更新を取得できます。ファイルにセルフリンクがない場合、それは不可能です。

キャッシング

フィードは継続的なポーリングによって追跡されます。これはサーバーにかなりの負荷をかける可能性があります。キャッシュヘッダーを設定することで、リーダーを制御するのに役立ちます。ガイダンスを提供しない場合、すべてのクライアントが独自の値を設定しますが、それは速すぎたり遅すぎたりする可能性があります。提案をすると、それに従うクライアントもいます。投稿頻度に基づいて合理的な値を選択してください。ブログが毎月更新される場合、1時間のキャッシュが適切でしょう。しかし、1日に何度も投稿している場合は、5分間のキャッシュがより適しているかもしれません。

キャッシュヘッダーの例:

  • 5分: Cache-Control: max-age=300
  • 15分: Cache-Control: max-age=900
  • 1時間: Cache-Control: max-age=3600

予約投稿を使用しており、非常に凝ったことをしたい場合は、次の投稿の公開時期に基づいてキャッシュ時間を変更できます。しかし、静的なキャッシュ時間でも十分です。

条件付きリクエスト

フィードで条件付きリクエストをサポートしてください。これにより、あなたとユーザー双方にとってポーリングが効率的になります。

ETagおよび/またはLast-Modifiedヘッダーを返してください。その後、フィードが変更されていない場合は304レスポンスを返してください。詳細については、MDNのHTTP条件付きリクエストを参照してください。

WebSub

WebSubは、リアルタイムのフィード更新のための標準です。これにより、更新がより速くプッシュされるだけでなく、サーバーへの負荷も軽減されます。

公開ハブを使用するか、自分で実行できます。ハブはフィードの内容を変更または挿入する可能性があるため、選択したハブを信頼できることを確認してください。

一般的なセットアップ手順の良いものが見つかりませんが、Googleハブはホームページに基本的な手順があります。いつかガイドを書くかもしれません…

ボットアクセス

ボットブロック技術を使用している場合は、フィードに対してそれをオフにする(または大幅に弱める)ことを確認してください。フィードはボットによって消費されることを意図しています!そうしないと、ユーザーはフィードにアクセスするのに苦労し、新しいコンテンツを知ることができなくなります。

多くの人気 サイトがこの問題を抱えています。以前にこの件について書きました。さまざまなサービスのデフォルト設定によって損なわれていないことを確認してください。

カテゴリ

カテゴリは、フィード内のアイテムをフィルタリングするための信頼性の高い方法です。一部のコンテンツに悩まされて購読者を失うよりも、1つのカテゴリ、または1つを除くすべてのカテゴリを購読できるようにする方がはるかに良いです。

Atomフィードの場合、カテゴリの追加は1つの要素で簡単です。例えば、この投稿は私のフィードに以下のマークアップを含んでいます。

<category term="RSS"/>
<category term="Guide"/>

RSS 2の場合、構文はわずかに異なります。

<category>Rant</category>

一部のリーダーはカテゴリをサポートしていないため、カテゴリごとに異なるフィードを生成するか、カテゴリでフィルタリングするためのURLパラメータをフィードに提供することを検討するかもしれません。個人的には、これについては心配しません。

URLの変更

可能な限り、フィードのURLを変更することは避けるべきです。しかし、変更する必要がある場合は、多くの購読者を失うことなく行う方法を以下に示します。

  1. 新しいURLでフィードを利用できるようにし、古いURLでも引き続き利用できるようにします。
  2. 新しいフィードのセルフリンクが新しいURLを指していることを確認します。
  3. WebSubを使用している場合は、投稿するたびに両方のURLに対してハブにpingを送信し始めます。
  4. 古いURLから新しいURLへ308永続リダイレクトでリダイレクトします。
  5. WebSubを使用している場合は、少なくとも3ヶ月間、またはハブの最大購読期間(いずれか長い方)の間、古いURLへのpingを送信し続けます。

一部の購読者は移動しないことを覚えておいてください。リダイレクトをできるだけ長く維持するように努めてください。長期間経過した後、リダイレクトを新しい場所の読者に通知するエントリを含むフィードに置き換えることを検討してもよいでしょう。しかし、予防は治療に勝るため、最初から良いURL(自分が管理できるもの)を選ぶようにしてください。

CORS

CORS、またはCross-Origin Resource Sharingは、元のWebセキュリティモデルのいくつかの穴を修正するための応急処置です。Webページが行えるリクエストに制限を加え、レスポンスに関する情報を制御します。

これはフィードに関連しています。CORSをオプトアウトしない場合、クライアントサイドでフィードを取得するブラウザベースのリーダーはフィードにアクセスできなくなります。

フィードの場合、以下のヘッダーはすべてのフィードに対して十分かつ安全です。

Access-Control-Allow-Origin: *

これは、フィードが公開リソースとしてリクエストできることを意味します(特にCookieは送信されません)。

テストするには、任意のサードパーティ製ウェブページ(例: https://example.com)に移動し、開発者コンソールで以下のJavaScriptを実行します。

fetch("https://YOUR_FEED_HERE").then(r => r.text()).then(console.log, console.error)

フィードの内容がログに記録されれば、すべてうまくいっています。エラーが発生した場合は、何かが間違っています。

パフォーマンス

小規模でローカルなフィードリーダーは単純なポーリングレートを使用する傾向がありますが、多くの大規模サービスはさまざまなヒューリスティックを使用してフィードをチェックするタイミングを決定します。WebSubをサポートしていない場合は、1秒未満でフィードリクエストに応答することを目指すべきです。フィードが遅い場合、特に3秒よりも遅い場合、ポーリングは遅くなり、読者は更新を遅く受け取ることになります。


この点より下の項目は、比較的重要ではありません。製品やフィードジェネレーターを作成している場合には良いアイデアですが、自分のブログのフィードを作成しているだけなら、おそらく時間の価値はありません。

要約

一部のリーダーは、短いスニペットを記事のプレビューとして表示します。フィードに要約を提供することで、優れたユーザーエクスペリエンスのために高品質なコンテンツを提供できます。明示的な要約を提供しない場合、通常は最初の段落やメインコンテンツの最初の数文が使用されます。

ページネーションは、フィードアーカイブを利用可能に保ちながら、最近のアイテムのサイズを小さく保つための便利なツールです。RFC 5005: Feed Paging and Archivingで指定されています。残念ながら、サポートしているクライアントはほとんどありません。しかし、フィードにサポートを追加してもデメリットはないため、依然として良いアイデアです。

ページネーションは非常に簡単です。フィードに以下のリンクを追加するだけです。

<link href="https://kevincox.ca/feed/2022-03-05.atom" rel="next"/>

その後、後続のページにもprevリンクを含めます。もちろん、最後のページにはnextリンクがありません。

<link href="https://kevincox.ca/feed.atom" rel="prev"/>
<link href="https://kevincox.ca/feed/2022-01-21.atom" rel="next"/>

ページのサイズを決定する際には、すべてのクライアントがページネーションをサポートしているわけではないことを覚えておく必要があるため、新しいエントリを最初のページからあまり早く移動させたくありません。以下の推奨事項を提供します。これらは一般的なルールであり、慎重に適用されるべきことに注意してください。例えば、1日に20回投稿する場合、フィードに7日分のコンテンツを保持する必要はおそらくありません。同様に、投稿が1〜2段落しかない場合は、最初のページにさらにいくつか保持できるかもしれません。

  1. 最新のアイテムが最初のページにあることを確認してください。
  2. アイテムをフィードに少なくとも1日保持するようにしてください。一部のクライアントは非常に頻繁にチェックします。可能であれば、少なくとも1週間アイテムを保持してください。
  3. フィードが大きくなりすぎないようにしてください。1メガバイト未満が推奨されます。