Einen Webfeed veröffentlichen: RSS 2.0, Atom oder JSON Feed, und die Details, auf die Reader angewiesen sind

Ziel

Readern, Aggregatoren und Agenten eine maschinenlesbare Liste neuer Inhalte geben, die sie günstig abfragen und zuverlässig deduplizieren können.

Voraussetzungen

Eine kanonische URL, ein stabiler Identifikator und ein Veröffentlichungszeitstempel für jeden Eintrag sowie serverseitiges Templating für das Feed-Dokument.

Schritte

1. Ein Format wählen. Atom (RFC 4287) ist am strengsten: Feed und Entry müssen je genau ein id, title und updated enthalten; Datumsangaben folgen RFC 3339; der Inhalt gibt seinen Typ an (text, html, xhtml). RSS 2.0 verlangt die Kanalelemente title, link und description; alle Elementfelder sind optional, doch mindestens title oder description muss vorhanden sein; Datumsangaben folgen RFC 822 (Sat, 07 Sep 2002 00:00:01 GMT); guid identifiziert einen Eintrag, und dessen Attribut isPermaLink ist standardmässig true. JSON Feed 1.1 ist dasselbe Modell in JSON: eine version-URL, title sowie items mit einem erforderlichen id und content_html oder content_text, ausgeliefert als application/feed+json. Atom oder JSON Feed eignet sich für neue Websites; RSS nur ergänzen, wenn ein Konsument danach verlangt.
2. Stabile IDs verwenden: die kanonische URL des Eintrags oder eine tag:-URI, die sich nie ändert, auch wenn sich Titel oder Slug ändern. Sich ändernde IDs lassen jeden Reader alte Einträge als neu anzeigen.
3. Vollständigen Inhalt in den Feed aufnehmen (Atom content, RSS description mit entity-kodiertem HTML, JSON content_html), bereinigt wie jedes ausgelieferte HTML, mit absoluten URLs für Links und Bilder.
4. Den richtigen Medientyp ausliefern (application/atom+xml, application/rss+xml, application/feed+json), Conditional GET mit ETag oder Last-Modified unterstützen, wie es die JSON-Feed-Spezifikation Herausgebern empfiehlt, und das Dokument auf die neuesten Einträge begrenzen, mit Paginierung für das Archiv.
5. Den Feed mit <link rel="alternate" type="application/atom+xml" href="/feed.xml"> im HTML-Head bekannt machen sowie mit einem sichtbaren Link auf der Seite.
6. Mit einem Feed-Validator sowie durch das Abonnieren in zwei Readern validieren; einen Eintrag bearbeiten und prüfen, dass er an Ort und Stelle aktualisiert wird, statt dupliziert zu werden.

Erwartetes Ergebnis

Reader zeigen jeden Eintrag nur einmal an, mit korrekten Daten und funktionierenden Links, und Abfrager erhalten zwischen Änderungen 304-Antworten.

Grenzen und Prüfbasis

Die Fakten zum Format stammen aus den zitierten Spezifikationen; das Verhalten der Reader unterscheidet sich je nach Produkt und wird hier nicht gemessen. Atoms updated bedeutet eine wesentliche Änderung, nicht die Veröffentlichung, und wird leicht damit verwechselt; nachsichtiges Parsen von RSS-Datumsangaben verbirgt Fehler, bis ein strenger Konsument auftritt.