Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot

Abstract

El presente proyecto tiene como objetivo implementar una biblioteca Maven que pueda ser utilizada por la organización consultada para poder automatizar una de las tareas del proceso de desarrollo de software que elaboran cada uno de sus respectivos equipos. Esta automatización será capaz de poder generar la documentación de los servicios REST java desarrollados por la compañía de manera automática, logrando así reducir los tiempos requeridos en el proceso mencionado, los cuales logran diferentes beneficios, entre ellos el económico.

Para la realización de este proyecto, se investigaron las diferentes razones por la cual la documentación técnica es muchas veces ineficiente o inexistente, con ellos se logró dar un mejor enfoque a la solución a plantear, de manera que se pueda maximizar el beneficio del mismo. Además, para el proyecto de implementación se analizó la metodología óptima para su desarrollo, así como el lenguaje de programación y las diferentes especialidades que conformarían al equipo.

La solución planteada requiere de un conjunto de herramientas para que pueda ser aprovechado de la mejor manera, entre ellos a Jenkins para la integración continua, Bitbucket para almacenar y versionar el código fuente, Artifactory para almacenar los artefactos generados. Todos estos han sido validados por la organización consultada.

The objective of this project is to implement a Maven library that can be used by the consulted organization to be able to automate one of the tasks of the software development process that each of their respective teams elaborates. This automation will be able to generate the documentation of the java REST services developed by the company automatically, thus reducing the time required in the process, which achieves different benefits, including an economic one.

For the realization of this project, the different reasons why the technical documentation is often inefficient or non-existent were investigated, with them it was possible to give a better approach to the solution to be proposed, so that its benefit can be maximized. In addition, for the implementation project, the optimal methodology for its development was analyzed, as well as the programming language and the different specialties that the team would require.

The proposed solution requires a set of tools so that it can be used in the best way, including Jenkins for continuous integration, Bitbucket for storage and source code versioning, and Artifactory to store the generated artifacts. All of these have been validated by the consulted organization.