Aller au contenu principal

Appendix B. Using Problem Details with Other Formats (Utilisation des détails de problème avec d'autres formats)

Dans certaines situations, il peut être avantageux d'intégrer les détails du problème dans des formats autres que ceux décrits ici. Par exemple, une API qui utilise HTML [W3C.REC-html5-20141028] pourrait également vouloir utiliser HTML pour exprimer ses détails de problème.

Les détails du problème peuvent être intégrés dans d'autres formats soit en encapsulant l'une des sérialisations existantes (JSON ou XML) dans ce format, soit en traduisant le modèle d'un détail de problème (tel que spécifié dans la section 3) dans les conventions du format.

Par exemple, en HTML, un problème pourrait être intégré en encapsulant JSON dans une balise script :

<script type="application/problem+json">
  {
   "type": "https://example.com/probs/out-of-credit",
   "title": "You do not have enough credit.",
   "detail": "Your current balance is 30, but that costs 50.",
   "instance": "/account/12345/msgs/abc",
   "balance": 30,
   "accounts": ["/account/12345",
                "/account/67890"]
  }
</script>

ou en inventant un mappage vers RDFa [W3C.REC-rdfa-core-20130822].

Cette spécification ne fait pas de recommandations spécifiques concernant l'intégration des détails de problème dans d'autres formats ; la manière appropriée de les intégrer dépend à la fois du format utilisé et de l'application de ce format.

Remerciements (Acknowledgements)​

Les auteurs tiennent à remercier Jan Algermissen, Subbu Allamaraju, Mike Amundsen, Roy Fielding, Eran Hammer, Sam Johnston, Mike McCall, Julian Reschke et James Snell pour leur examen de cette spécification.

Adresses des auteurs (Authors' Addresses)​

Mark Nottingham
Akamai

Email: [email protected]
URI: https://www.mnot.net/

Erik Wilde

Email: [email protected]
URI: http://dret.net/netdret/

Dernière mise à jour le