Descripción de la propiedad del archivo para swagger @esquema en Spring Boot.

Answer

1. 

   davy.ai

   July 12, 2023 at 12:33 am

   Sí, puedes utilizar un archivo de propiedades similar a un diccionario para Swagger. Una forma de lograr esto es definir un JsonSerializer personalizado para la anotación @Schema que utiliza un ResourceBundle para leer las propiedades. Aquí tienes un ejemplo:

   public class SchemaWithPropertiesJsonSerializer extends JsonSerializer<schema> {
   
       private final ResourceBundle resourceBundle;
   
       public SchemaWithPropertiesJsonSerializer(ResourceBundle resourceBundle) {
           this.resourceBundle = resourceBundle;
       }
   
       @Override
       public void serialize(Schema value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
           ObjectNode node = new ObjectMapper().valueToTree(value);
           String descriptionKey = node.get("description").asText();
           String description = resourceBundle.getString(descriptionKey);
           node.put("description", description);
           gen.writeTree(node);
       }
   }
   

   En este ejemplo, el serializador personalizado lee el campo “description” de la anotación @Schema y lo utiliza como una clave para leer la descripción real desde un ResourceBundle. Puedes añadir lógica similar para otros atributos como “required”.

   Para utilizar este serializador personalizado, necesitas registrarlo con el ObjectMapper utilizado por Swagger. Aquí tienes un ejemplo:

   @Configuration
   public class SwaggerConfig {
   
       @Autowired
       private MessageSource messageSource;
   
       @Bean
       public Jackson2ObjectMapperBuilderCustomizer customizer() {
           return builder -> {
               SimpleModule module = new SimpleModule();
               module.addSerializer(new SchemaWithPropertiesJsonSerializer(ResourceBundle.getBundle("ruta/al/archivo/de/propiedades", Locale.getDefault())));
               builder.modules(module);
           };
       }
   
       @Bean
       public OpenAPI customOpenAPI() {
           // configura tu objeto OpenAPI aquí
       }
   }
   

   En este ejemplo, el serializador personalizado se añade al ObjectMapper utilizado por Swagger a través de un Jackson2ObjectMapperBuilderCustomizer. El ResourceBundle se carga desde un archivo de propiedades en “ruta/al/archivo/de/propiedades”, con la configuración regional predeterminada. Puedes personalizar estos valores según tus necesidades.

   Con esta configuración, puedes utilizar la anotación @Schema con claves de propiedades en lugar de valores reales, y el serializador personalizado leerá los valores desde el ResourceBundle en tiempo de ejecución. Aquí tienes un ejemplo:

   @Schema(description = "postalCode.description", required = "postalCode.required")
   private String postalCode;
   

   En este ejemplo, “postalCode.description” y “postalCode.required” son claves en el ResourceBundle que corresponden a la descripción y los valores requeridos reales para el campo postalCode.

Comments are closed.