java-to-zod-maven-plugin – java-to-zod:generate (original) (raw)

Full name:

sh.ivan:java-to-zod-maven-plugin:0.6.2:generate

Description:

Generates Zod schemas from specified java classes.

Attributes:

Required Parameters

Name Type Since Description
JsonLibrary - Library used in JSON classes. Supported values are: jackson2 - annotations from `com.fasterxml.jackson.annotation` package jaxb - annotations from `javax.xml.bind.annotation` package gson - annotations from `com.google.gson.annotations` package jsonb - annotations from `javax.json.bind.annotation` package Required parameter, recommended value is jackson2.
File - Path and name of generated file.Default value is: project.build.directory/java−to−zod/{project.build.directory}/java-to-zod/project.build.directory/java−to−zod/{project.artifactId}-schemas.js.

Optional Parameters

Name Type Since Description
List - Classes to process.
List - Classes to process specified by extended superclasses.
boolean - Scans JAX-RS resources for JSON classes to process. It is possible to exclude particular REST resource classes using excludeClasses parameter.
String - Scans specified JAX-RS javax.ws.rs.core.Application for classes to process. Parameter contains fully-qualified class name. It is possible to exclude particular REST resource classes using excludeClasses parameter.
List - Classes to process specified by implemented interface.
List - Classes to process specified by annotations.
List - Classes to process specified using glob patterns so it is possible to specify package or class name suffix. Glob patterns support two wildcards: Single * wildcard matches any character except for . and $. Double ** wildcard matches any character. For more information and examples see Class Names Glob Patterns Wiki page.
List - List of classes excluded from processing.
List - Excluded classes specified using glob patterns. For more information and examples see Class Names Glob Patterns Wiki page.
List - Properties with any of these annotations will be excluded.
GsonConfiguration - Specifies Gson global configuration. Description of individual parameters is in GsonConfiguration class on GitHub (latest version).
List - If this list is not empty then only properties with any of these annotations will be included.
Jackson2Configuration - Specifies Jackson 2 global configuration. Description of individual parameters is in Jackson2Configuration class on GitHub (latest version).
JsonbConfiguration - Specifies JSON-B global configuration. Description of individual parameters is in Jackson2Configuration class on GitHub (latest version).
Logger$Level - Specifies level of logging output. Supported values are: Debug Verbose Info Warning Error Default value is Verbose.
List - Allows to speed up classpath scanning by limiting scanning to specified packages. This optimization applies to following parameters: classPatterns classesImplementingInterfaces classesExtendingClasses classesWithAnnotations classesFromAutomaticJaxrsApplication This parameter is passed directly to underlying classpath scanning library (ClassGraph) without any validation or interpretation.
boolean - If true Spring REST application will be loaded and scanned for classes to process. It is needed to specify application class using another parameter (for example classes).
String - Prefix added to generated schema names.
String - Suffix added to generated schema names.Default value is: Schema.
boolean - (no description)User property is: java.to.zod.skip.

Parameter Details

Classes to process.

Classes to process specified by extended superclasses.

Scans JAX-RS resources for JSON classes to process. It is possible to exclude particular REST resource classes using excludeClasses parameter.

Scans specified JAX-RS javax.ws.rs.core.Application for classes to process. Parameter contains fully-qualified class name. It is possible to exclude particular REST resource classes using excludeClasses parameter.

Classes to process specified by implemented interface.

Classes to process specified by annotations.

Classes to process specified using glob patterns so it is possible to specify package or class name suffix. Glob patterns support two wildcards:

For more information and examples see Class Names Glob Patterns Wiki page.

List of classes excluded from processing.

Excluded classes specified using glob patterns. For more information and examples see Class Names Glob Patterns Wiki page.

Properties with any of these annotations will be excluded.

Specifies Gson global configuration. Description of individual parameters is in GsonConfiguration class on GitHub (latest version).

If this list is not empty then only properties with any of these annotations will be included.

Specifies Jackson 2 global configuration. Description of individual parameters is in Jackson2Configuration class on GitHub (latest version).

Specifies JSON-B global configuration. Description of individual parameters is in Jackson2Configuration class on GitHub (latest version).

Library used in JSON classes. Supported values are:

Required parameter, recommended value is jackson2.

Specifies level of logging output. Supported values are:

Default value is Verbose.

Path and name of generated file.

Allows to speed up classpath scanning by limiting scanning to specified packages. This optimization applies to following parameters:

This parameter is passed directly to underlying classpath scanning library (ClassGraph) without any validation or interpretation.

If true Spring REST application will be loaded and scanned for classes to process. It is needed to specify application class using another parameter (for example classes).

Prefix added to generated schema names.

Suffix added to generated schema names.

(no description)