Recommandations à d’autres personnes envisageant Open API Documentation for Confluence:
Oui, c'est vraiment bien pour documenter de grands produits logiciels. Avis collecté par et hébergé sur G2.com.
Quels sont les problèmes que Open API Documentation for Confluence résout, et en quoi cela vous est-il bénéfique?
Je travaille dans une entreprise de développement de logiciels où je travaille sur plusieurs logiciels. Pour chaque logiciel, nous avons le document approprié, la feuille de route, le diagramme de flux d'architecture, le schéma de base de données et de nombreux autres composants connexes. Nous utilisons Confluence pour documenter tout en un seul endroit. Le confluence fournit de jolis modèles pour la création d'artefacts. De plus, nous l'intégrons avec la pile Jira.
Les membres de mon équipe créent des JSON ou YAML conformes à l'API ouverte afin que nous générions une documentation belle et interactive sur la page confluence. De plus, cela offre plusieurs options pour le faire, soit nous pouvons le récupérer directement à partir d'une URL donnée, soit le coller dans le corps du macro.
Depuis le confluence lui-même, nous pouvons utiliser le mode interactif Try It Out! pour tester les opérations de l'API, le corps de la réponse, les codes d'état, les en-têtes, etc. Avis collecté par et hébergé sur G2.com.