Existe-t-il des normes ou des meilleures pratiques acceptées pour documenter un ensemble d'API JSON? Fait un peu de recherche autour et il semble y avoir un peu de méli-mélo de style / formats.
Peut-être faire un gros problème à ce sujet ... à un certain niveau, les documents sont des documents, mais je me suis dit que je demanderais.
Je ne pense pas qu'il existe une méthode standard, mais qui établit la norme sinon les gros poissons? Regardez comment Twitter le documente peut-être ( http://apiwiki.twitter.com/ )? C'est probablement ce que la plupart des développeurs attendraient, je suppose.
Le seul moyen de le faire est de donner des exemples de l'JSON retourné. Cela fonctionne bien pour de simples JSON qui n'ont pas trop de variations et n'est pas trop profondément imbriqués.
Pour les plus complexes JSON, je vous recommande de regarder la proposition faite dans la question de la Syntaxe pour la documentation de la structure JSON Je pense que le "Taycher JSON de Grammaire de Forme" (TJGF) est une belle façon de document complexe JSON dans une manière qui est facile à lire et est en accord avec la légèreté d'esprit de JSON. Il a besoin de quelques extensions pour gérer des solutions de rechange et des éléments facultatifs, mais qui doit être facile à ajouter.
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.
