Feat: Ability to generate custom annotations for any model properties

example/build.yaml

@@ -19,6 +19,9 @@ targets:
             - url: "https://raw.githubusercontent.com/epam-cross-platform-lab/swagger-dart-code-generator/master/example/input_folder/pet_service_json.json"
               file_name: "some_file_name.json"
             - url: "https://raw.githubusercontent.com/epam-cross-platform-lab/swagger-dart-code-generator/master/example/input_folder/pet_service_yaml.yaml"
+          custom_annotations:
+            - type_name: 'SomeCustomAnnotations'
+              swagger_key: 'some_custom_annotations'
           with_base_url: true
           with_converter: true
           use_path_for_request_names: true

example/input_folder/pet_service_json.json

@@ -939,7 +939,8 @@
         "userStatus": {
           "type": "integer",
           "format": "int32",
-          "description": "User Status"
+          "description": "User Status",
+          "some_custom_annotations": "ski-ba-bop-ba-dop-bop"
         }
       },
       "xml": {

example/lib/swagger_generated_code/pet_service_json.swagger.dart

@@ -553,6 +553,7 @@ class User {
   @JsonKey(name: 'phone', includeIfNull: false, defaultValue: '')
   final String? phone;
   @JsonKey(name: 'userStatus', includeIfNull: false)
+  @SomeCustomAnnotations('ski-ba-bop-ba-dop-bop')
   final int? userStatus;
   static const fromJsonFactory = _$UserFromJson;
 

lib/src/code_generators/swagger_models_generator.dart

@@ -526,11 +526,30 @@ class $className implements json.JsonConverter<${value.type}, String> {
       typeName = typeName.makeNullable();
     }
 
+    var jsonCustomAnnotationContent = '';
+    var rawJson = prop.rawJson;
+    if (null != rawJson) {
+      for (var customAnnotation in options.customAnnotations) {
+        if (rawJson.containsKey(customAnnotation.swaggerKey)) {
+          var jsonPropKeyValue = rawJson[customAnnotation.swaggerKey];
+          if (null != jsonPropKeyValue) {
+            jsonCustomAnnotationContent += "\t@${customAnnotation.typeName}(";
+            if (jsonPropKeyValue is String) {
+              jsonCustomAnnotationContent += "'$jsonPropKeyValue'";
+            } else {
+              jsonCustomAnnotationContent += "$jsonPropKeyValue";
+            }
+            jsonCustomAnnotationContent += ")\n";
+          }
+        }
+      }
+    }
+
     final jsonKeyContent =
         "@JsonKey(name: '$propertyKey'$includeIfNullString$dateToJsonValue${unknownEnumValue.jsonKey})\n";
     final deprecatedContent = isDeprecated ? '@deprecated\n' : '';
 
-    return '\t$jsonKeyContent$deprecatedContent\tfinal $typeName ${generateFieldName(propertyName)};${unknownEnumValue.fromJson}';
+    return '\t$jsonKeyContent$deprecatedContent$jsonCustomAnnotationContent\tfinal $typeName ${generateFieldName(propertyName)};${unknownEnumValue.fromJson}';
   }
 
   JsonEnumValue generateEnumValue({
@@ -875,7 +894,26 @@ static $returnType $fromJsonFunction($valueType? value) => $enumNameCamelCase$fr
       typeName += '?';
     }
 
-    return '\t$jsonKeyContent$deprecatedContent\tfinal $typeName $propertyName;${unknownEnumValue.fromJson}';
+    var jsonCustomAnnotationContent = '';
+    var rawJson = prop.rawJson;
+    if (null != rawJson) {
+      for (var customAnnotation in options.customAnnotations) {
+        if (rawJson.containsKey(customAnnotation.swaggerKey)) {
+          var jsonPropKeyValue = rawJson[customAnnotation.swaggerKey];
+          if (null != jsonPropKeyValue) {
+            jsonCustomAnnotationContent += "\t@${customAnnotation.typeName}(";
+            if (jsonPropKeyValue is String) {
+              jsonCustomAnnotationContent += "'$jsonPropKeyValue'";
+            } else {
+              jsonCustomAnnotationContent += "$jsonPropKeyValue";
+            }
+            jsonCustomAnnotationContent += ")\n";
+          }
+        }
+      }
+    }
+
+    return '\t$jsonKeyContent$deprecatedContent$jsonCustomAnnotationContent\tfinal $typeName $propertyName;${unknownEnumValue.fromJson}';
   }
 
   String generateEnumPropertyContent({
@@ -1066,8 +1104,26 @@ static $returnType $fromJsonFunction($valueType? value) => $enumNameCamelCase$fr
         !requiredProperties.contains(propertyKey)) {
       listPropertyName = listPropertyName.makeNullable();
     }
-
-    return '$jsonConverterAnnotation$jsonKeyContent$deprecatedContent final $listPropertyName ${generateFieldName(propertyName)};${unknownEnumValue.fromJson}';
+
+    var jsonCustomAnnotationContent = '';
+    var rawJson = prop.rawJson;
+    if (null != rawJson) {
+      for (var customAnnotation in options.customAnnotations) {
+        if (rawJson.containsKey(customAnnotation.swaggerKey)) {
+          var jsonPropKeyValue = rawJson[customAnnotation.swaggerKey];
+          if (null != jsonPropKeyValue) {
+            jsonCustomAnnotationContent += "\t@${customAnnotation.typeName}(";
+            if (jsonPropKeyValue is String) {
+              jsonCustomAnnotationContent += "'$jsonPropKeyValue'";
+            } else {
+              jsonCustomAnnotationContent += "$jsonPropKeyValue";
+            }
+            jsonCustomAnnotationContent += ")\n";
+          }
+        }
+      }
+    }
+    return '$jsonConverterAnnotation$jsonKeyContent$deprecatedContent$jsonCustomAnnotationContent final $listPropertyName ${generateFieldName(propertyName)};${unknownEnumValue.fromJson}';
   }
 
   String generateGeneralPropertyContent({
@@ -1144,7 +1200,26 @@ static $returnType $fromJsonFunction($valueType? value) => $enumNameCamelCase$fr
       typeName = typeName.makeNullable();
     }
 
-    return '\t$jsonConverterAnnotation$jsonKeyContent$isDeprecatedContent  final $typeName $propertyName;${unknownEnumValue.fromJson}';
+    var jsonCustomAnnotationContent = '';
+    var rawJson = prop.rawJson;
+    if (null != rawJson) {
+      for (var customAnnotation in options.customAnnotations) {
+        if (rawJson.containsKey(customAnnotation.swaggerKey)) {
+          var jsonPropKeyValue = rawJson[customAnnotation.swaggerKey];
+          if (null != jsonPropKeyValue) {
+            jsonCustomAnnotationContent += "\t@${customAnnotation.typeName}(";
+            if (jsonPropKeyValue is String) {
+              jsonCustomAnnotationContent += "'$jsonPropKeyValue'";
+            } else {
+              jsonCustomAnnotationContent += "$jsonPropKeyValue";
+            }
+            jsonCustomAnnotationContent += ")\n";
+          }
+        }
+      }
+    }
+
+    return '\t$jsonConverterAnnotation$jsonKeyContent$isDeprecatedContent$jsonCustomAnnotationContent  final $typeName $propertyName;${unknownEnumValue.fromJson}';
   }
 
   String generatePropertyContentByType(

lib/src/models/generator_options.dart

@@ -40,6 +40,7 @@ class GeneratorOptions {
     this.multipartFileType = 'List<int>',
     this.urlencodedFileType = 'Map<String, String>',
     this.generateFirstSucceedResponse = true,
+    this.customAnnotations = const[],
   });
 
   /// Build options from a JSON map.
@@ -81,6 +82,8 @@ class GeneratorOptions {
   final String customReturnType;
   final List<String> excludePaths;
 
+  @JsonKey(defaultValue: <CustomAnnotationMap>[])
+  final List<CustomAnnotationMap> customAnnotations;
   /// Convert this options instance to JSON.
   Map<String, dynamic> toJson() => _$GeneratorOptionsToJson(this);
 }
@@ -200,4 +203,22 @@ class CustomScalar {
   });
 
   Map<String, dynamic> toJson() => _$CustomScalarToJson(this);
-}
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class CustomAnnotationMap {
+  CustomAnnotationMap({required this.typeName, required this.swaggerKey});
+
+  /// Build a default value map from a JSON map.
+  factory CustomAnnotationMap.fromJson(Map<String, dynamic> json) =>
+      _$CustomAnnotationMapFromJson(json);
+
+  @JsonKey(defaultValue: '')
+  final String typeName;
+
+  @JsonKey(defaultValue: '')
+  final String swaggerKey;
+
+  /// Convert this default value map instance to JSON.
+  Map<String, dynamic> toJson() => _$CustomAnnotationMapToJson(this);
+}

lib/src/swagger_models/responses/swagger_schema.dart

@@ -28,6 +28,7 @@ class SwaggerSchema {
     this.readOnly = false,
     this.writeOnly = false,
     this.deprecated = false,
+    this.rawJson,
   }) : _type = type;
 
   @JsonKey(name: 'readOnly')
@@ -36,6 +37,9 @@ class SwaggerSchema {
   @JsonKey(name: 'writeOnly')
   bool writeOnly;
 
+  @JsonKey(name: 'rawJson')
+  Map<String, dynamic>? rawJson;
+
   @JsonKey(name: 'type')
   dynamic _type;
   String get type {
@@ -132,6 +136,7 @@ class SwaggerSchema {
 
   factory SwaggerSchema.fromJson(Map<String, dynamic> json) =>
       _$SwaggerSchemaFromJson(json)
+        ..rawJson = json
         ..enumNames = ((json[kEnumNames] ?? json[kEnumVarnames]) as List?)
             ?.map((e) => e as String)
             .toList()