[dart] Fix api client deserialization for json_serializable (#8882)

* Fix api-client deserialization for json_serializable * Use raw string for url path * Use Set/List.of * Use returnTypeIsPrimitive in template * Regenerate all templates * Fix casting map to Iterable of things * Add json_serializable to maven modules * Run build_runner before pub run test * Return future of type for strong linter mode
OpenAPITools · Mar 11, 2021 · b782cff · b782cff
1 parent f7a6b7f
commit b782cff
Show file tree

Hide file tree

Showing 31 changed files with 433 additions and 453 deletions.
diff --git a/modules/openapi-generator/src/main/resources/dart2/api.mustache b/modules/openapi-generator/src/main/resources/dart2/api.mustache
@@ -61,7 +61,7 @@ class {{{classname}}} {
     {{/allParams}}
 
   {{/hasParams}}
-    final path = '{{{path}}}'{{#pathParams}}
+    final path = r'{{{path}}}'{{#pathParams}}
       .replaceAll('{' + '{{{baseName}}}' + '}', {{{paramName}}}.toString()){{/pathParams}};
 
     Object postBody{{#bodyParam}} = {{{paramName}}}{{/bodyParam}};
@@ -185,21 +185,47 @@ class {{{classname}}} {
     // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
-      {{#isArray}}
+    {{#native_serialization}}
+    {{#isArray}}
       return (apiClient.deserialize(_decodeBodyBytes(response), '{{{returnType}}}') as List)
         .cast<{{{returnBaseType}}}>()
         .{{#uniqueItems}}toSet(){{/uniqueItems}}{{^uniqueItems}}toList(growable: false){{/uniqueItems}};
-      {{/isArray}}
-      {{^isArray}}
-        {{#isMap}}
+    {{/isArray}}
+    {{^isArray}}
+    {{#isMap}}
       return {{{returnType}}}.from(apiClient.deserialize(_decodeBodyBytes(response), '{{{returnType}}}'));
-        {{/isMap}}
-        {{^isMap}}
+    {{/isMap}}
+    {{^isMap}}
       return apiClient.deserialize(_decodeBodyBytes(response), '{{{returnType}}}') as {{{returnType}}};
-        {{/isMap}}
-      {{/isArray}}
+    {{/isMap}}{{/isArray}}{{/native_serialization}}{{#json_serializable}}
+    {{#isArray}}
+      {{#uniqueItems}}
+      return (json.decode(response.body) as List)
+        .map((i) => {{{returnBaseType}}}.fromJson(i))
+        .toSet();
+      {{/uniqueItems}}
+      {{^uniqueItems}}
+      return (json.decode(response.body) as List)
+        .map((i) => {{{returnBaseType}}}.fromJson(i))
+        .toList();
+      {{/uniqueItems}}
+    {{/isArray}}
+    {{^isArray}}
+    {{#isMap}}
+      return {{{returnType}}}.from(json.decode(response.body));
+    {{/isMap}}
+    {{^isMap}}
+    {{#returnTypeIsPrimitive}}
+      return response.body as {{{returnBaseType}}};
+    {{/returnTypeIsPrimitive}}
+    {{^returnTypeIsPrimitive}}
+      return {{{returnType}}}.fromJson(json.decode(response.body));
+    {{/returnTypeIsPrimitive}}
+    {{/isMap}}
+    {{/isArray}}
+    {{/json_serializable}}
     }
-    return null;
+    return Future<{{{returnType}}}>.value(null);
     {{/returnType}}
   }
   {{/operation}}

diff --git a/modules/openapi-generator/src/main/resources/dart2/api_client.mustache b/modules/openapi-generator/src/main/resources/dart2/api_client.mustache
@@ -56,17 +56,6 @@ class ApiClient {
   Map<String, Authentication> get authentications =>
       Map.unmodifiable(_authentications);
 
-  dynamic deserialize(String json, String targetType, {bool growable}) {
-    // Remove all spaces.  Necessary for reg expressions as well.
-    targetType = targetType.replaceAll(' ', '');
-
-    return targetType == 'String'
-      ? json
-      : _deserialize(jsonDecode(json), targetType, growable: true == growable);
-  }
-
-  String serialize(Object obj) => obj == null ? '' : json.encode(obj);
-
   T getAuthentication<T extends Authentication>(String name) {
     final authentication = _authentications[name];
     return authentication is T ? authentication : null;
@@ -159,6 +148,7 @@ class ApiClient {
     throw ApiException(HttpStatus.badRequest, 'Invalid HTTP operation: $method $path',);
   }
 
+{{#native_serialization}}
   dynamic _deserialize(dynamic value, String targetType, {bool growable}) {
     try {
       switch (targetType) {
@@ -216,6 +206,18 @@ class ApiClient {
     throw ApiException(HttpStatus.internalServerError, 'Could not find a suitable class for deserialization',);
   }
 
+  dynamic deserialize(String json, String targetType, {bool growable}) {
+    // Remove all spaces.  Necessary for reg expressions as well.
+    targetType = targetType.replaceAll(' ', '');
+
+  return targetType == 'String'
+    ? json
+    : _deserialize(jsonDecode(json), targetType, growable: true == growable);
+  }
+{{/native_serialization}}
+
+  String serialize(Object obj) => obj == null ? '' : json.encode(obj);
+
   /// Update query and header parameters based on authentication settings.
   /// @param authNames The authentications to apply
   void _updateParamsForAuth(

diff --git a/modules/openapi-generator/src/main/resources/dart2/api_helper.mustache b/modules/openapi-generator/src/main/resources/dart2/api_helper.mustache
@@ -53,8 +53,7 @@ String parameterToString(dynamic value) {
     {{#model}}
       {{#isEnum}}
   if (value is {{{classname}}}) {
-{{#native_serialization}}    return {{{classname}}}TypeTransformer().encode(value).toString();{{/native_serialization}}
-{{#json_serializable}}    return _${{{classname}}}EnumMap[value];{{/json_serializable}}
+{{#native_serialization}}    return {{{classname}}}TypeTransformer().encode(value).toString();{{/native_serialization}}{{#json_serializable}}    return value.toString();{{/json_serializable}}
   }
       {{/isEnum}}
     {{/model}}

diff --git a/pom.xml b/pom.xml
@@ -1353,6 +1353,7 @@
                 <module>samples/client/petstore/dart2/petstore</module>
                 <module>samples/openapi3/client/petstore/dart2/petstore_client_lib</module>
                 <module>samples/openapi3/client/petstore/dart2/petstore</module>
+                <module>samples/openapi3/client/petstore/dart2/petstore_json_serializable_client_lib_fake</module>
                 <module>samples/client/petstore/dart-dio/petstore_client_lib</module>
                 <module>samples/openapi3/client/petstore/dart-dio/petstore_client_lib</module>
                 <module>samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake</module>

diff --git a/samples/client/petstore/dart2/petstore_client_lib/lib/api/pet_api.dart b/samples/client/petstore/dart2/petstore_client_lib/lib/api/pet_api.dart
@@ -29,7 +29,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/pet';
+    final path = r'/pet';
 
     Object postBody = body;
 
@@ -94,7 +94,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: petId');
     }
 
-    final path = '/pet/{petId}'
+    final path = r'/pet/{petId}'
       .replaceAll('{' + 'petId' + '}', petId.toString());
 
     Object postBody;
@@ -166,7 +166,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: status');
     }
 
-    final path = '/pet/findByStatus';
+    final path = r'/pet/findByStatus';
 
     Object postBody;
 
@@ -225,7 +225,7 @@ class PetApi {
         .cast<Pet>()
         .toList(growable: false);
     }
-    return null;
+    return Future<List<Pet>>.value(null);
   }
 
   /// Finds Pets by tags
@@ -244,7 +244,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: tags');
     }
 
-    final path = '/pet/findByTags';
+    final path = r'/pet/findByTags';
 
     Object postBody;
 
@@ -303,7 +303,7 @@ class PetApi {
         .cast<Pet>()
         .toList(growable: false);
     }
-    return null;
+    return Future<List<Pet>>.value(null);
   }
 
   /// Find pet by ID
@@ -322,7 +322,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: petId');
     }
 
-    final path = '/pet/{petId}'
+    final path = r'/pet/{petId}'
       .replaceAll('{' + 'petId' + '}', petId.toString());
 
     Object postBody;
@@ -377,8 +377,8 @@ class PetApi {
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return apiClient.deserialize(_decodeBodyBytes(response), 'Pet') as Pet;
-    }
-    return null;
+        }
+    return Future<Pet>.value(null);
   }
 
   /// Update an existing pet
@@ -395,7 +395,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/pet';
+    final path = r'/pet';
 
     Object postBody = body;
 
@@ -464,7 +464,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: petId');
     }
 
-    final path = '/pet/{petId}'
+    final path = r'/pet/{petId}'
       .replaceAll('{' + 'petId' + '}', petId.toString());
 
     Object postBody;
@@ -554,7 +554,7 @@ class PetApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: petId');
     }
 
-    final path = '/pet/{petId}/uploadImage'
+    final path = r'/pet/{petId}/uploadImage'
       .replaceAll('{' + 'petId' + '}', petId.toString());
 
     Object postBody;
@@ -625,7 +625,7 @@ class PetApi {
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return apiClient.deserialize(_decodeBodyBytes(response), 'ApiResponse') as ApiResponse;
-    }
-    return null;
+        }
+    return Future<ApiResponse>.value(null);
   }
 }
diff --git a/samples/client/petstore/dart2/petstore_client_lib/lib/api/store_api.dart b/samples/client/petstore/dart2/petstore_client_lib/lib/api/store_api.dart
@@ -31,7 +31,7 @@ class StoreApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: orderId');
     }
 
-    final path = '/store/order/{orderId}'
+    final path = r'/store/order/{orderId}'
       .replaceAll('{' + 'orderId' + '}', orderId.toString());
 
     Object postBody;
@@ -89,7 +89,7 @@ class StoreApi {
   ///
   /// Note: This method returns the HTTP [Response].
   Future<Response> getInventoryWithHttpInfo() async {
-    final path = '/store/inventory';
+    final path = r'/store/inventory';
 
     Object postBody;
 
@@ -139,7 +139,7 @@ class StoreApi {
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return Map<String, int>.from(apiClient.deserialize(_decodeBodyBytes(response), 'Map<String, int>'));
     }
-    return null;
+    return Future<Map<String, int>>.value(null);
   }
 
   /// Find purchase order by ID
@@ -158,7 +158,7 @@ class StoreApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: orderId');
     }
 
-    final path = '/store/order/{orderId}'
+    final path = r'/store/order/{orderId}'
       .replaceAll('{' + 'orderId' + '}', orderId.toString());
 
     Object postBody;
@@ -213,8 +213,8 @@ class StoreApi {
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return apiClient.deserialize(_decodeBodyBytes(response), 'Order') as Order;
-    }
-    return null;
+        }
+    return Future<Order>.value(null);
   }
 
   /// Place an order for a pet
@@ -231,7 +231,7 @@ class StoreApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/store/order';
+    final path = r'/store/order';
 
     Object postBody = body;
 
@@ -283,7 +283,7 @@ class StoreApi {
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return apiClient.deserialize(_decodeBodyBytes(response), 'Order') as Order;
-    }
-    return null;
+        }
+    return Future<Order>.value(null);
   }
 }
diff --git a/samples/client/petstore/dart2/petstore_client_lib/lib/api/user_api.dart b/samples/client/petstore/dart2/petstore_client_lib/lib/api/user_api.dart
@@ -31,7 +31,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/user';
+    final path = r'/user';
 
     Object postBody = body;
 
@@ -96,7 +96,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/user/createWithArray';
+    final path = r'/user/createWithArray';
 
     Object postBody = body;
 
@@ -159,7 +159,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/user/createWithList';
+    final path = r'/user/createWithList';
 
     Object postBody = body;
 
@@ -224,7 +224,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: username');
     }
 
-    final path = '/user/{username}'
+    final path = r'/user/{username}'
       .replaceAll('{' + 'username' + '}', username.toString());
 
     Object postBody;
@@ -290,7 +290,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: username');
     }
 
-    final path = '/user/{username}'
+    final path = r'/user/{username}'
       .replaceAll('{' + 'username' + '}', username.toString());
 
     Object postBody;
@@ -343,8 +343,8 @@ class UserApi {
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return apiClient.deserialize(_decodeBodyBytes(response), 'User') as User;
-    }
-    return null;
+        }
+    return Future<User>.value(null);
   }
 
   /// Logs user into the system
@@ -367,7 +367,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: password');
     }
 
-    final path = '/user/login';
+    final path = r'/user/login';
 
     Object postBody;
 
@@ -425,15 +425,15 @@ class UserApi {
     // FormatException when trying to decode an empty string.
     if (response.body != null && response.statusCode != HttpStatus.noContent) {
       return apiClient.deserialize(_decodeBodyBytes(response), 'String') as String;
-    }
-    return null;
+        }
+    return Future<String>.value(null);
   }
 
   /// Logs out current logged in user session
   ///
   /// Note: This method returns the HTTP [Response].
   Future<Response> logoutUserWithHttpInfo() async {
-    final path = '/user/logout';
+    final path = r'/user/logout';
 
     Object postBody;
 
@@ -499,7 +499,7 @@ class UserApi {
      throw ApiException(HttpStatus.badRequest, 'Missing required param: body');
     }
 
-    final path = '/user/{username}'
+    final path = r'/user/{username}'
       .replaceAll('{' + 'username' + '}', username.toString());
 
     Object postBody = body;