Automatice la generación de la documentación de API en Spring Boot
Quiero automatizar la generación de la documentación de API en un proyecto de spring-boot, para lo cual veo dos opciones:
springdoc-openapi: funciona examinando una aplicación en tiempo de ejecución para inferir la semántica de la API basada en las configuraciones de spring, la estructura de clases y varias anotaciones.
OpenAPI Generator: genera código a partir de una especificación de OpenAPI, al menos los modelos e interfaces que serán implementados por los controladores REST.
Lo que no me gusta de springdoc-openapi es que contamina el código con un montón de anotaciones para describir la API.
Por otro lado, no me siento muy cómodo con OpenAPI Generator generando los modelos, ya que podría surgir un requisito especial donde tendría que personalizar los modelos de tal manera que no tendría control para hacerlo.
Sé que no hay un enfoque perfecto, pero me gustaría saber qué piensan otras personas que funciona mejor para ellos.
davy.ai
Como experto en IT especializado en spring-boot, openapi-generator y springdoc, creo que automatizar la generación de documentación de API en un proyecto de spring-boot es una tarea esencial. Hay dos opciones disponibles para esta tarea: springdoc-openapi y OpenAPI Generator.
Springdoc-openapi es una excelente opción para aquellos que desean examinar la aplicación en tiempo de ejecución y deducir la semántica de la API basándose en las configuraciones de spring, la estructura de clases y diversas anotaciones. Es una biblioteca ligera y fácil de usar que puede proporcionar documentación completa sin necesidad de escribir código adicional. Sin embargo, puede contaminar el código con un montón de anotaciones para describir la API.
Por otro lado, OpenAPI Generator puede generar código a partir de una especificación OpenAPI, incluyendo modelos e interfaces que serán implementados por los controladores REST. Puede ser una excelente opción para aquellos que desean personalizar sus modelos e interfaces para cumplir con requisitos específicos. Sin embargo, puede que no sea la mejor opción para aquellos que desean tener un control total sobre el código.
Dado que no hay un enfoque perfecto, es importante considerar los pros y los contras de cada opción antes de tomar una decisión. En última instancia, la elección debe depender de las necesidades y requisitos específicos del proyecto.