Génération de la documentation à partir de POJO avec des annotations Java Bean Validation

Question

Nous avons des beans existants générés à partir de XSD avec JAXB. Il y a beaucoup (vraiment) de fichiers XSD donc la compilation pour cette partie prend du temps. Nous avons un plugin Maven personnalisé qui génère un catalogue HTML de tous les beans en lisant les XSD.

Nous aimerions nous débarrasser de JAXB car la documentation dans le XSD n'est pas conservée dans le bean généré et certaines contraintes exprimées en XML ne sont pas correctement traduites en Java ou ne sont pas suffisamment appliquées.

Nous souhaitons utiliser les annotations Java Bean Validation (avec des annotations personnalisées si nécessaire). Connaissez-vous un plugin/une bibliothèque/tout ce qui pourrait fusionner les commentaires Javadoc existants avec la documentation générée à partir des annotations Java Bean Validation?

import lombok.Getter; 
import lombok.Setter; 

import javax.validation.constraints.NotNull; 
import javax.validation.constraints.Size; 

/** 
* Documentation... 
*/ 
@Getter 
@Setter 
public class Bean { 

    /** 
    * Documentation with javadoc annotations 
    */ 
    @NotNull 
    @Size(min = 3, max = 20) 
    private String message; 

} 

Par exemple, pour la propriété de message la documentation ressemblerait à ceci:

Documentation avec annotations javadoc
"message" ne doit pas être nul.
La taille "message" doit être comprise entre 3 et 20 caractères.

Answer 1

Vous devriez essayer le plugin JAutoDoc pour générer Javadoc (eclipse, STS, ..). Il a des choix pour générer: remplacer existant, compléter existant, conserver existant. En plus de cela, vous pouvez personnalisé choix varié. marché du lien: https://marketplace.eclipse.org/content/jautodoc

Answer 2

annotations de contraintes Bean Validation font déjà partie de JavaDoc généré (ou toute annotation qui est vraiment méta-annotée avec @Documented). Si cela ne suffit pas, vous pouvez envisager d'écrire un doclet personnalisé qui ajoute une représentation textuelle de cette métadonnée de contrainte.