Skip to content

[dart][dart-dio] Remove manual json encode/decode calls in API classes #8812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 3 commits into from
Feb 24, 2021
Merged

[dart][dart-dio] Remove manual json encode/decode calls in API classes #8812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7da535
[dart][dart-dio] Remove manual json encode/decode calls in API classes
kuhnroyal Feb 23, 2021
e539a69
[dart] Constraint test library to < 1.16.0 as it requires Dart 2.12.0
kuhnroyal Feb 23, 2021
49918d2
Fix more constraint problems for the new test project
kuhnroyal Feb 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 6 additions & 17 deletions modules/openapi-generator/src/main/resources/dart-dio/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{{>header}}
import 'dart:async';
import 'dart:convert';
import 'package:dio/dio.dart';
import 'package:built_value/serializer.dart';

Expand Down Expand Up @@ -72,24 +71,22 @@ class {{classname}} {
{{#isContainer}}
{{#isArray}}
const type = FullType(Built{{#uniqueItems}}Built{{/uniqueItems}}{{^uniqueItems}}List{{/uniqueItems}}, [FullType({{baseType}})]);
final serializedBody = _serializers.serialize({{paramName}}, specifiedType: type);
bodyData = _serializers.serialize({{paramName}}, specifiedType: type);
{{/isArray}}
{{#isMap}}
const type = FullType(BuiltMap, [FullType(String), FullType({{baseType}})]);
final serializedBody = _serializers.serialize({{paramName}}, specifiedType: type);
bodyData = _serializers.serialize({{paramName}}, specifiedType: type);
{{/isMap}}
{{/isContainer}}
{{^isContainer}}
{{#isPrimitiveType}}
final serializedBody = {{paramName}};
bodyData = {{paramName}};
{{/isPrimitiveType}}
{{^isPrimitiveType}}
final bodySerializer = _serializers.serializerForType({{{baseType}}}) as Serializer<{{{baseType}}}>;
final serializedBody = _serializers.serializeWith(bodySerializer, {{paramName}});
bodyData = _serializers.serializeWith(bodySerializer, {{paramName}});
{{/isPrimitiveType}}
{{/isContainer}}
final json{{paramName}} = json.encode(serializedBody);
bodyData = json{{paramName}};
{{/bodyParam}}

return _dio.request<dynamic>(
Expand Down Expand Up @@ -130,20 +127,12 @@ class {{classname}} {
{{/returnTypeIsPrimitive}}
{{^returnTypeIsPrimitive}}
final serializer = _serializers.serializerForType({{{returnType}}}) as Serializer<{{{returnType}}}>;
final data = _serializers.deserializeWith<{{{returnType}}}>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<{{{returnType}}}>(serializer, response.data);
{{/returnTypeIsPrimitive}}
{{/returnSimpleType}}
{{^returnSimpleType}}
const type = FullType(Built{{#isMap}}Map{{/isMap}}{{#isArray}}{{#uniqueItems}}Set{{/uniqueItems}}{{^uniqueItems}}List{{/uniqueItems}}{{/isArray}}, [{{#isMap}}FullType(String), {{/isMap}}FullType({{{returnBaseType}}})]);
final data = _serializers.deserialize(
response.data is String
? jsonDecode(response.data as String)
: response.data,
specifiedType: type,
) as {{{returnType}}};
final data = _serializers.deserialize(response.data, specifiedType: type) as {{{returnType}}};
{{/returnSimpleType}}
{{/isResponseFile}}

Expand Down
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/dart-dio/pubspec.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ dependencies:
dev_dependencies:
built_value_generator: ">=7.1.0 <9.0.0"
build_runner: ^1.7.1
test: ^1.3.0
test: ">=1.3.0 <1.16.0"

2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/dart2/pubspec.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ dependencies:
intl: '^0.16.1'
meta: '^1.1.8'
dev_dependencies:
test: '^1.3.0'
test: '>=1.3.0 <1.16.0'
33 changes: 6 additions & 27 deletions samples/client/petstore/dart-dio/petstore_client_lib/lib/api/pet_api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
// ignore_for_file: unused_import

import 'dart:async';
import 'dart:convert';
import 'package:dio/dio.dart';
import 'package:built_value/serializer.dart';

Expand Down Expand Up @@ -53,9 +52,7 @@ class PetApi {
];

final bodySerializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final serializedBody = _serializers.serializeWith(bodySerializer, body);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serializeWith(bodySerializer, body);

return _dio.request<dynamic>(
_path,
Expand Down Expand Up @@ -184,12 +181,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
const type = FullType(BuiltList, [FullType(Pet)]);
final data = _serializers.deserialize(
response.data is String
? jsonDecode(response.data as String)
: response.data,
specifiedType: type,
) as BuiltList<Pet>;
final data = _serializers.deserialize(response.data, specifiedType: type) as BuiltList<Pet>;

return Response<BuiltList<Pet>>(
data: data,
Expand Down Expand Up @@ -254,12 +246,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
const type = FullType(BuiltList, [FullType(Pet)]);
final data = _serializers.deserialize(
response.data is String
? jsonDecode(response.data as String)
: response.data,
specifiedType: type,
) as BuiltList<Pet>;
final data = _serializers.deserialize(response.data, specifiedType: type) as BuiltList<Pet>;

return Response<BuiltList<Pet>>(
data: data,
Expand Down Expand Up @@ -325,10 +312,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final data = _serializers.deserializeWith<Pet>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<Pet>(serializer, response.data);

return Response<Pet>(
data: data,
Expand Down Expand Up @@ -372,9 +356,7 @@ class PetApi {
];

final bodySerializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final serializedBody = _serializers.serializeWith(bodySerializer, body);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serializeWith(bodySerializer, body);

return _dio.request<dynamic>(
_path,
Expand Down Expand Up @@ -520,10 +502,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(ApiResponse) as Serializer<ApiResponse>;
final data = _serializers.deserializeWith<ApiResponse>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<ApiResponse>(serializer, response.data);

return Response<ApiResponse>(
data: data,
Expand Down
22 changes: 4 additions & 18 deletions samples/client/petstore/dart-dio/petstore_client_lib/lib/api/store_api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
// ignore_for_file: unused_import

import 'dart:async';
import 'dart:convert';
import 'package:dio/dio.dart';
import 'package:built_value/serializer.dart';

Expand Down Expand Up @@ -116,12 +115,7 @@ class StoreApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
const type = FullType(BuiltMap, [FullType(String), FullType(int)]);
final data = _serializers.deserialize(
response.data is String
? jsonDecode(response.data as String)
: response.data,
specifiedType: type,
) as BuiltMap<String, int>;
final data = _serializers.deserialize(response.data, specifiedType: type) as BuiltMap<String, int>;

return Response<BuiltMap<String, int>>(
data: data,
Expand Down Expand Up @@ -180,10 +174,7 @@ class StoreApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(Order) as Serializer<Order>;
final data = _serializers.deserializeWith<Order>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<Order>(serializer, response.data);

return Response<Order>(
data: data,
Expand Down Expand Up @@ -224,9 +215,7 @@ class StoreApi {
final contentTypes = <String>[];

final bodySerializer = _serializers.serializerForType(Order) as Serializer<Order>;
final serializedBody = _serializers.serializeWith(bodySerializer, body);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serializeWith(bodySerializer, body);

return _dio.request<dynamic>(
_path,
Expand All @@ -247,10 +236,7 @@ class StoreApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(Order) as Serializer<Order>;
final data = _serializers.deserializeWith<Order>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<Order>(serializer, response.data);

return Response<Order>(
data: data,
Expand Down
22 changes: 5 additions & 17 deletions samples/client/petstore/dart-dio/petstore_client_lib/lib/api/user_api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
// ignore_for_file: unused_import

import 'dart:async';
import 'dart:convert';
import 'package:dio/dio.dart';
import 'package:built_value/serializer.dart';

Expand Down Expand Up @@ -47,9 +46,7 @@ class UserApi {
final contentTypes = <String>[];

final bodySerializer = _serializers.serializerForType(User) as Serializer<User>;
final serializedBody = _serializers.serializeWith(bodySerializer, body);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serializeWith(bodySerializer, body);

return _dio.request<dynamic>(
_path,
Expand Down Expand Up @@ -97,9 +94,7 @@ class UserApi {
final contentTypes = <String>[];

const type = FullType(BuiltList, [FullType(User)]);
final serializedBody = _serializers.serialize(body, specifiedType: type);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serialize(body, specifiedType: type);

return _dio.request<dynamic>(
_path,
Expand Down Expand Up @@ -147,9 +142,7 @@ class UserApi {
final contentTypes = <String>[];

const type = FullType(BuiltList, [FullType(User)]);
final serializedBody = _serializers.serialize(body, specifiedType: type);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serialize(body, specifiedType: type);

return _dio.request<dynamic>(
_path,
Expand Down Expand Up @@ -260,10 +253,7 @@ class UserApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(User) as Serializer<User>;
final data = _serializers.deserializeWith<User>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<User>(serializer, response.data);

return Response<User>(
data: data,
Expand Down Expand Up @@ -410,9 +400,7 @@ class UserApi {
final contentTypes = <String>[];

final bodySerializer = _serializers.serializerForType(User) as Serializer<User>;
final serializedBody = _serializers.serializeWith(bodySerializer, body);
final jsonbody = json.encode(serializedBody);
bodyData = jsonbody;
bodyData = _serializers.serializeWith(bodySerializer, body);

return _dio.request<dynamic>(
_path,
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/dart-dio/petstore_client_lib/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ dependencies:
dev_dependencies:
built_value_generator: ">=7.1.0 <9.0.0"
build_runner: ^1.7.1
test: ^1.3.0
test: ">=1.3.0 <1.16.0"

2 changes: 1 addition & 1 deletion samples/client/petstore/dart2/petstore_client_lib/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ dependencies:
intl: '^0.16.1'
meta: '^1.1.8'
dev_dependencies:
test: '^1.3.0'
test: '>=1.3.0 <1.16.0'
43 changes: 8 additions & 35 deletions samples/openapi3/client/petstore/dart-dio/petstore_client_lib/lib/api/pet_api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
// ignore_for_file: unused_import

import 'dart:async';
import 'dart:convert';
import 'package:dio/dio.dart';
import 'package:built_value/serializer.dart';

Expand Down Expand Up @@ -53,9 +52,7 @@ class PetApi {
];

final bodySerializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final serializedBody = _serializers.serializeWith(bodySerializer, pet);
final jsonpet = json.encode(serializedBody);
bodyData = jsonpet;
bodyData = _serializers.serializeWith(bodySerializer, pet);

return _dio.request<dynamic>(
_path,
Expand All @@ -81,10 +78,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final data = _serializers.deserializeWith<Pet>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<Pet>(serializer, response.data);

return Response<Pet>(
data: data,
Expand Down Expand Up @@ -201,12 +195,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
const type = FullType(BuiltList, [FullType(Pet)]);
final data = _serializers.deserialize(
response.data is String
? jsonDecode(response.data as String)
: response.data,
specifiedType: type,
) as BuiltList<Pet>;
final data = _serializers.deserialize(response.data, specifiedType: type) as BuiltList<Pet>;

return Response<BuiltList<Pet>>(
data: data,
Expand Down Expand Up @@ -271,12 +260,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
const type = FullType(BuiltList, [FullType(Pet)]);
final data = _serializers.deserialize(
response.data is String
? jsonDecode(response.data as String)
: response.data,
specifiedType: type,
) as BuiltList<Pet>;
final data = _serializers.deserialize(response.data, specifiedType: type) as BuiltList<Pet>;

return Response<BuiltList<Pet>>(
data: data,
Expand Down Expand Up @@ -342,10 +326,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final data = _serializers.deserializeWith<Pet>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<Pet>(serializer, response.data);

return Response<Pet>(
data: data,
Expand Down Expand Up @@ -389,9 +370,7 @@ class PetApi {
];

final bodySerializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final serializedBody = _serializers.serializeWith(bodySerializer, pet);
final jsonpet = json.encode(serializedBody);
bodyData = jsonpet;
bodyData = _serializers.serializeWith(bodySerializer, pet);

return _dio.request<dynamic>(
_path,
Expand All @@ -417,10 +396,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(Pet) as Serializer<Pet>;
final data = _serializers.deserializeWith<Pet>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<Pet>(serializer, response.data);

return Response<Pet>(
data: data,
Expand Down Expand Up @@ -554,10 +530,7 @@ class PetApi {
onReceiveProgress: onReceiveProgress,
).then((response) {
final serializer = _serializers.serializerForType(ApiResponse) as Serializer<ApiResponse>;
final data = _serializers.deserializeWith<ApiResponse>(
serializer,
response.data is String ? jsonDecode(response.data as String) : response.data,
);
final data = _serializers.deserializeWith<ApiResponse>(serializer, response.data);

return Response<ApiResponse>(
data: data,
Expand Down
Loading