Generación de especificación OpenAPI de Swagger para DPS v2
La especificación OpenAPI se genera para cada definición de configuración definida como un bean.
La especificación Swagger OpenAPI se adapta automáticamente para usar el payload generado con base en la clase de payload de las definiciones de configuración.
La implementación está disponible en el módulo dynamic-processing-settings-open-api-spec.
¿Cómo usarlo?
Agregue la siguiente dependencia en su proyecto
<dependency>
<groupId>com.iconsolutions.ipf.core.dynamicsettings.v2</groupId>
<artifactId>dynamic-processing-settings-open-api-spec</artifactId>
</dependency>y defina un nuevo bean DpsOpenAPISpecConfiguration en su configuración.
Funcionalidades
-
Clases de payload complejas: Manejo de clases de payload complejas desde la clase de payload de la definición de configuración (p. ej., GenericProcessingSettings de csm-reachability). Generación de payload en Swagger para todos los subtipos de la clase de payload cargados en la JVM.
-
ConfigurableEnum: soporte que genera los valores posibles en Swagger OpenAPI a partir de la configuración.
-
Extensibilidad: el proyecto padre tiene la capacidad de extender la OpenAPI generada agregando lógica personalizada en setting definition settingDefinitionOpenAPISpecCustomizer.
-
Fácil de usar: los usuarios de Swagger pueden probar fácilmente los endpoints REST utilizando un esqueleto de solicitud generado automáticamente que refleja la estructura de la clase de payload.