J'implémente actuellement un ensemble de services Webdestiné à être utilisé par les clients JavaScript et utilise Google Gson pour la sérialisation / désérialisation JSON. Mes contrats de service sont donc définis dans des classes Java. J'ai maintenant besoin d'un moyen de générer de la documentation de ces interfaces de messagerie d'une manière destinée à être utilisée par les développeurs JavaScript.
Idéalement, je voudrais un outil dans la lignée deJavaDoc qui a généré des exemples JSON, des schémas JSON ou une autre documentation de mes types adaptée aux développeurs Web, pouvant être facilement intégrée à Maven afin de produire une documentation HTML pour les types avec une annotation donnée.
Je peux les diriger vers le JavaDoc généré, maisles obligera à comprendre et à parcourir tous les champs privés pour savoir comment formater les demandes, sans tenir compte des convertisseurs de type Gson, etc.
Existe-t-il des outils pertinents disponibles dans ce domaine?
Réponses:
0 pour la réponse № 1J'ai utilisé Swagger par le passé. Il est simple à mettre en œuvre, tout en générant de puissantes documentations API.
Veuillez consulter cette documentation. Je pense que c'est ce que vous recherchez.
http://petstore.swagger.wordnik.com/