97 votes

Convention pour l'en-tête de réponse HTTP afin de notifier aux clients les API dépréciées

Je suis en train de mettre à jour les points de terminaison de notre API REST et je veux avertir les clients lorsqu'ils appellent le point de terminaison qui va être déprécié.
Quel en-tête dois-je utiliser dans la réponse avec un message du type "Cette version de l'API est obsolète, veuillez consulter la dernière documentation pour mettre à jour vos points d'extrémité" ?

5voto

dret Points 476

Il existe un champ d'en-tête HTTP appelé Sunset qui est destiné à signaler la dépréciation prochaine d'une ressource. https://datatracker.ietf.org/doc/html/draft-wilde-sunset-header est dans les dernières étapes pour devenir un RFC. Idéalement, votre API devrait documenter le fait qu'elle va utiliser les éléments suivants Sunset afin que les clients puissent les rechercher et agir en conséquence, s'ils le souhaitent.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X