Deprecated & Converts

EasyApi provides built-in extensions for deprecated info and type conversions.

Deprecated Info

The deprecated extension (enabled by default) automatically extracts deprecation information from Java and Kotlin code:

# Java deprecated
method.doc[#deprecated]=groovy:"\n「Deprecated」" + it.doc("deprecated")
method.doc[@java.lang.Deprecated]=「Deprecated」
field.doc[#deprecated]=groovy:"\n「Deprecated」" + it.doc("deprecated")
field.doc[@java.lang.Deprecated]=「Deprecated」

# Kotlin deprecated
method.doc[@kotlin.Deprecated]=groovy:"\n「Deprecated」" + it.ann("kotlin.Deprecated","message")
field.doc[@kotlin.Deprecated]=groovy:"\n「Deprecated」" + it.ann("kotlin.Deprecated","message")

Type Converts

The converts extension (enabled by default) provides automatic type conversions for common Java types:

From	To
org.bson.types.ObjectId	java.lang.String
java.util.Date	java.lang.String
java.sql.Date	java.lang.String
java.sql.Time	java.lang.String
java.sql.Timestamp	java.lang.String
java.time.LocalDateTime	java.lang.String
java.time.LocalDate	java.lang.String
java.math.BigInteger	java.lang.Long
java.net.URL	java.lang.String
AtomicBoolean	java.lang.Boolean
AtomicLong	java.lang.Long
AtomicInteger	java.lang.Integer

Field Utils

The field-utils extension (enabled by default) provides sensible defaults for field handling:

• Ignore fields from java.lang system classes
• Ignore transient fields
• Ignore serialVersionUID
• Ignore common system types (Class, ClassLoader, Thread, ThreadLocal, etc.)

Public fields are exported

Before v3.2.0 the field-utils extension carried a blanket rule that dropped every field that was not private or protected, so DTOs exposing business data through public fields (query-param DTOs, for example) were exported with an empty body. That rule has been removed — public and package-private fields are now exported like private ones. To restore the old behaviour, add this to a rule file:

field.ignore=groovy:!(it.hasModifier("private")||it.hasModifier("protected"))