Publier un flux web : RSS 2.0, Atom ou JSON Feed, et les détails dont dépendent les lecteurs

Objectif

Fournir aux lecteurs, aux agrégateurs et aux agents une liste de contenus nouveaux, lisible par une machine, qu'ils peuvent interroger à faible coût et dédupliquer de façon fiable.

Prérequis

Une URL canonique, un identifiant stable et un horodatage de publication pour chaque élément, ainsi qu'un gabarit côté serveur pour le document de flux.

Étapes

1. Choisir un format. Atom (RFC 4287) est le plus strict : le flux et chaque entrée doivent chacun contenir exactement un id, un title et un updated ; les dates suivent la RFC 3339 ; le contenu déclare son type (text, html, xhtml). RSS 2.0 exige les éléments de canal title, link et description ; tous les éléments d'un item sont facultatifs, mais au moins title ou description doit être présent ; les dates suivent la RFC 822 (Sat, 07 Sep 2002 00:00:01 GMT) ; guid identifie un item, et son attribut isPermaLink vaut vrai par défaut. JSON Feed 1.1 reprend le même modèle en JSON : une URL version, un title, et des items comportant obligatoirement un id et un content_html ou content_text, servis en application/feed+json. Atom ou JSON Feed convient aux nouveaux sites ; n'ajouter RSS que si un consommateur le demande.
2. Utiliser des identifiants stables : l'URL canonique de l'élément ou une URI tag: qui ne change jamais, même lorsque le titre ou le slug change. Changer les identifiants fait apparaître chez chaque lecteur les anciens éléments comme nouveaux.
3. Placer le contenu complet dans le flux (content d'Atom, description de RSS avec du HTML encodé en entités, content_html de JSON), assaini comme tout HTML servi, avec des URL absolues pour les liens et les images.
4. Servir le bon type de média (application/atom+xml, application/rss+xml, application/feed+json), prendre en charge le GET conditionnel avec ETag ou Last-Modified comme le recommande la spécification JSON Feed aux éditeurs, et limiter le document aux éléments les plus récents, avec une pagination pour l'archive.
5. Signaler le flux avec <link rel="alternate" type="application/atom+xml" href="/feed.xml"> dans l'en-tête HTML, ainsi qu'un lien visible sur la page.
6. Valider avec un validateur de flux et en s'abonnant dans deux lecteurs ; modifier un élément et vérifier qu'il se met à jour sur place plutôt que de se dupliquer.

Résultat attendu

Les lecteurs voient chaque élément une seule fois, avec des dates correctes et des liens fonctionnels, et les interrogateurs reçoivent des réponses 304 entre deux changements.

Limites et base de vérification

Les éléments factuels sur les formats proviennent des spécifications citées ; le comportement des lecteurs varie selon le produit et n'est pas mesuré ici. Le updated d'Atom signifie une modification significative, pas une publication, et il est facile de confondre les deux ; une analyse laxiste des dates RSS masque les erreurs jusqu'à l'apparition d'un consommateur strict.