GH-249 Support OpenApiByFields(only = true) (Resolve #249)

Author: dzikoysk

examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java

@@ -162,7 +162,8 @@ public static void main(String[] args) {
                 @OpenApiContent(from = LombokEntity.class, mimeType = "app/lombok"), // lombok
                 @OpenApiContent(from = EntityWithGenericType.class), // generics
                 @OpenApiContent(from = RecordEntity.class, mimeType = "app/record"), // record class
-                @OpenApiContent(from = DtoWithFields.class, mimeType = "app/dto"), // map only fields
+                @OpenApiContent(from = DtoWithFields.class, mimeType = "app/dto-fields"), // map only fields
+                @OpenApiContent(from = DtoWithFieldsAndMethods.class, mimeType = "app/dto-fields-and-methods"), // map fields and methods
                 @OpenApiContent(from = EnumEntity.class, mimeType = "app/enum"), // enum,
                 @OpenApiContent(from = CustomNameEntity.class, mimeType = "app/custom-name-entity") // custom name
             }
@@ -470,13 +471,31 @@ record RecordEntity(
     ) {}
 
     // should query fields
-    @OpenApiByFields(Visibility.PROTECTED) // by default: PUBLIC
+    @OpenApiByFields(value = Visibility.PROTECTED, only = true) // by default: PUBLIC
     static final class DtoWithFields {
 
         public String publicName;
         String defaultName;
         protected String protectedName;
         private String privateName;
+
+        public String getCustom() {
+            return "custom";
+        }
+    }
+
+    // should query fields and methods
+    @OpenApiByFields(Visibility.PROTECTED) // by default: PUBLIC
+    static final class DtoWithFieldsAndMethods {
+
+        public String publicName;
+        String defaultName;
+        protected String protectedName;
+        private String privateName;
+
+        public String getCustom() {
+            return "custom";
+        }
     }
 
     enum EnumEntity {

openapi-annotation-processor/src/test/kotlin/io/javalin/openapi/processor/TypeMappersTest.kt

@@ -21,6 +21,16 @@ internal class TypeMappersTest : OpenApiAnnotationProcessorSpecification() {
 
     class CustomType // mapped by openapi.groovy
 
+    enum class StandardEnum {
+        VALUE_1,
+        VALUE_2,
+    }
+
+    enum class CapitalizedFirstLetterEnum {
+        Value1,
+        Value2,
+    }
+
     @Suppress("PLATFORM_CLASS_MAPPED_TO_KOTLIN", "RemoveRedundantQualifierName")
     class SimpleTypesList(
         val customType: CustomType,
@@ -53,7 +63,9 @@ internal class TypeMappersTest : OpenApiAnnotationProcessorSpecification() {
         val instant: Instant,
         val obj: Object,
         val map: Map<*, *>,
-        val mapWithList: Map<*, List<*>>
+        val mapWithList: Map<*, List<*>>,
+        val standardEnum: StandardEnum,
+        val capitalizedFirstLetterEnum: CapitalizedFirstLetterEnum,
     )
 
     @OpenApi(

openapi-specification/src/main/kotlin/io/javalin/openapi/OpenApiAnnotations.kt

@@ -308,10 +308,13 @@ enum class Visibility(val priority: Int) {
     PRIVATE(1)
 }
 
+/** Fields with the specified visibility or higher will be included in the schema */
 @Target(CLASS)
 @Retention(RUNTIME)
 annotation class OpenApiByFields(
-    val value: Visibility = PUBLIC
+    val value: Visibility = PUBLIC,
+    /** If true, methods will be ignored */
+    val only: Boolean = false,
 )
 
 /** Null class because annotations do not support null values */

openapi-specification/src/main/kotlin/io/javalin/openapi/experimental/processor/generators/TypeSchemaGenerator.kt

@@ -37,8 +37,7 @@ import javax.lang.model.element.AnnotationMirror
 import javax.lang.model.element.AnnotationValue
 import javax.lang.model.element.AnnotationValueVisitor
 import javax.lang.model.element.Element
-import javax.lang.model.element.ElementKind.ENUM
-import javax.lang.model.element.ElementKind.METHOD
+import javax.lang.model.element.ElementKind.*
 import javax.lang.model.element.ExecutableElement
 import javax.lang.model.element.Modifier
 import javax.lang.model.element.VariableElement
@@ -75,7 +74,6 @@ class TypeSchemaGenerator(val context: AnnotationProcessorContext) {
             composition != null -> {
                 schema.createComposition(context, type, composition, references, inlineRefs, requireNonNullsByDefault)
             }
-
             source.kind == ENUM -> {
                 val values = JsonArray()
                 source.enclosedElements
@@ -88,7 +86,6 @@ class TypeSchemaGenerator(val context: AnnotationProcessorContext) {
                 schema.addProperty("type", "string")
                 schema.add("enum", values)
             }
-
             else -> {
                 schema.addProperty("type", "object")
                 schema.addProperty("additionalProperties", false)
@@ -209,8 +206,7 @@ data class Property(
 )
 
 internal fun ClassDefinition.findAllProperties(requireNonNulls: Boolean): Collection<Property> = context.inContext {
-    val acceptFields = source.getAnnotation(OpenApiByFields::class.java)
-        ?.value
+    val openApiByFields: OpenApiByFields? = source.getAnnotation(OpenApiByFields::class.java)
 
     val isRecord = when (recordType()) {
         null -> false
@@ -230,10 +226,13 @@ internal fun ClassDefinition.findAllProperties(requireNonNulls: Boolean): Collec
                 continue
             }
 
-            if (property.kind != METHOD && acceptFields == null) {
-                continue
+            when {
+                property.kind != METHOD && openApiByFields == null -> continue
+                property.kind == METHOD && openApiByFields?.only == true -> continue
             }
 
+            val acceptFields = openApiByFields?.value
+
             if (acceptFields != null) {
                 val modifiers = property.modifiers
 
@@ -263,7 +262,7 @@ internal fun ClassDefinition.findAllProperties(requireNonNulls: Boolean): Collec
 
             val name = when {
                 customName != null -> customName.value
-                isRecord || acceptFields != null -> simpleName
+                isRecord || property.kind == FIELD -> simpleName
                 simpleName.startsWith("get") -> simpleName.replaceFirst("get", "").replaceFirstChar { it.lowercase() }
                 simpleName.startsWith("is") -> simpleName.replaceFirst("is", "").replaceFirstChar { it.lowercase() }
                 else -> continue