Recomendaciones a otros que estén considerando Open API Documentation for Confluence:
Sí, es realmente bueno para documentar grandes productos de software. Reseña recopilada por y alojada en G2.com.
¿Qué problemas resuelve Open API Documentation for Confluence ¿Y cómo te beneficia eso?
Trabajo en una empresa de desarrollo de software donde trabajo en múltiples programas. Para cada software, tenemos el documento adecuado, la hoja de ruta, el diagrama de flujo de arquitectura, el esquema de base de datos y muchos otros componentes relacionados. Usamos Confluence para documentar todo en un solo lugar. Confluence proporciona plantillas agradables para la creación de artefactos. Además, lo integramos con la pila de Jira.
Mis compañeros de equipo crean JSON o YAML compatibles con Open API para que generemos documentación hermosa e interactiva en la página de Confluence. También proporciona múltiples opciones para hacerlo, ya sea que podamos obtenerlo directamente desde una URL dada o pegarlo en el cuerpo del macro.
Desde el propio Confluence, podemos usar el modo interactivo ¡Pruébalo! para probar las operaciones de la API, el cuerpo de respuesta, los códigos de estado, los encabezados, etc. Reseña recopilada por y alojada en G2.com.