DPS v2 Swagger OpenAPI generación de especificaciones

El OpenAPI la especificación se genera utilizando para cada definición de configuración definida como un bean. El Swagger OpenAPI La especificación se adapta automáticamente para utilizar la carga útil generada basada en la clase de carga útil de las definiciones de configuración. La implementación está disponible en dynamic-processing-settings-open-api-spec módulo.

¿Cómo utilizarlo?

Agregue la siguiente dependencia a su proyecto.

<dependency>
    <groupId>com.iconsolutions.ipf.core.dynamicsettings.v2</groupId>
    <artifactId>dynamic-processing-settings-open-api-spec</artifactId>
</dependency>

y defina nueva DpsOpenAPISpecConfiguration bean en su configuración.

Características

  • Clases de carga complejas: Manejo de clases de carga complejas a partir de la definición de la clase de carga (por ejemplo, GenericProcessingSettings de csm-alcanzabilidad). Generando carga útil en Swagger para todos los subtipos de clase de carga cargados en JVM.

  • ConfigurableEnum: soporte que genera valores posibles en Swagger OpenAPI desde la configuración.

  • Extensibilidad: el proyecto principal tiene la capacidad de extender lo generado OpenAPI al agregar custom lógica en la definición de configuración settingDefinitionOpenAPISpecCustomizer.

  • Fácil de usar: Swagger los usuarios pueden probar sin esfuerzo REST puntos finales utilizando un esqueleto de solicitud generado automáticamente que refleja la estructura de la clase de carga útil.