Add new config parameter original_http_response(#116)

Co-authored-by: Roman Laptev <[email protected]>

swagger_parser/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.10.3
+- Add new config parameter `original_http_response`(only for dart) ([#115](https://github.com/Carapacik/swagger_parser/issues/115))
+
 ## 1.10.2
 - Fix error in `body` with name in dart template
 

swagger_parser/README.md

@@ -110,6 +110,9 @@ swagger_parser:
   # Optional. Set 'false' to not put a comment at the beginning of the generated files.
   mark_files_as_generated: true
 
+  # Optional (dart only). Set 'true' to wrap all request return types with HttpResponse.
+  original_http_response: false
+
   # Optional. Set regex replacement rules for the names of the generated classes/enums.
   # All rules are applied in order.
   replacement_rules:

swagger_parser/lib/src/config/yaml_config.dart

@@ -37,6 +37,7 @@ final class YamlConfig {
     this.enumsToJson,
     this.enumsPrefix,
     this.markFilesAsGenerated,
+    this.originalHttpResponse,
     this.replacementRules = const [],
   });
 
@@ -209,6 +210,13 @@ final class YamlConfig {
       );
     }
 
+    final originalHttpResponse = yamlConfig['original_http_response'];
+    if (originalHttpResponse is! bool?) {
+      throw const ConfigException(
+        "Config parameter 'original_http_response' must be bool.",
+      );
+    }
+
     final rawReplacementRules = yamlConfig['replacement_rules'];
     if (rawReplacementRules is! YamlList?) {
       throw const ConfigException(
@@ -254,6 +262,8 @@ final class YamlConfig {
       putClientsInFolder: putClientsInFolder ?? rootConfig?.putClientsInFolder,
       squashClients: squashClients ?? rootConfig?.squashClients,
       pathMethodName: pathMethodName ?? rootConfig?.pathMethodName,
+      originalHttpResponse:
+          originalHttpResponse ?? rootConfig?.originalHttpResponse,
       enumsToJson: enumsToJson ?? rootConfig?.enumsToJson,
       enumsPrefix: enumsPrefix ?? rootConfig?.enumsPrefix,
       markFilesAsGenerated:
@@ -352,5 +362,6 @@ final class YamlConfig {
   final bool? enumsToJson;
   final bool? enumsPrefix;
   final bool? markFilesAsGenerated;
+  final bool? originalHttpResponse;
   final List<ReplacementRule> replacementRules;
 }

swagger_parser/lib/src/generator/generator.dart

@@ -40,6 +40,7 @@ final class Generator {
     String? rootClientName,
     bool? putClientsInFolder,
     bool? squashClients,
+    bool? originalHttpResponse,
     bool? pathMethodName,
     bool? putInFolder,
     bool? enumsToJson,
@@ -61,6 +62,7 @@ final class Generator {
         _clientPostfix = clientPostfix ?? 'Client',
         _putClientsInFolder = putClientsInFolder ?? false,
         _squashClients = squashClients ?? false,
+        _originalHttpResponse = originalHttpResponse ?? false,
         _pathMethodName = pathMethodName ?? false,
         _putInFolder = putInFolder ?? false,
         _enumsToJson = enumsToJson ?? false,
@@ -84,6 +86,7 @@ final class Generator {
       clientPostfix: yamlConfig.clientPostfix,
       putClientsInFolder: yamlConfig.putClientsInFolder,
       squashClients: yamlConfig.squashClients,
+      originalHttpResponse: yamlConfig.originalHttpResponse,
       pathMethodName: yamlConfig.pathMethodName,
       putInFolder: yamlConfig.putInFolder,
       enumsToJson: yamlConfig.enumsToJson,
@@ -138,6 +141,9 @@ final class Generator {
   /// Squash all clients in one client.
   final bool _squashClients;
 
+  /// Generate request methods with HttpResponse<Entity>
+  final bool _originalHttpResponse;
+
   /// If true, use the endpoint path for the method name, if false, use operationId
   final bool _pathMethodName;
 
@@ -257,6 +263,7 @@ final class Generator {
       name: _name,
       squashClients: _squashClients,
       replacementRules: _replacementRules,
+      originalHttpResponse: _originalHttpResponse,
     );
     _openApiInfo = parser.parseOpenApiInfo();
     _restClients = parser.parseRestClients();

swagger_parser/lib/src/generator/models/universal_request.dart

@@ -16,6 +16,7 @@ final class UniversalRequest {
     this.isMultiPart = false,
     this.isFormUrlEncoded = false,
     this.isDeprecated = false,
+    this.isOriginalHttpResponse = false,
   });
 
   /// Request name
@@ -45,6 +46,9 @@ final class UniversalRequest {
   /// Value indicating whether this request is deprecated
   final bool isDeprecated;
 
+  /// Wrap request return type with HttpResponse
+  final bool isOriginalHttpResponse;
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||

swagger_parser/lib/src/generator/templates/dart_retrofit_client_template.dart

@@ -35,11 +35,14 @@ abstract class $name {
 }
 
 String _toClientRequest(UniversalRequest request) {
+  final responseType = request.returnType == null
+      ? 'void'
+      : request.returnType!.toSuitableType(ProgrammingLanguage.dart);
   final sb = StringBuffer(
     '''
 
   ${descriptionComment(request.description, tabForFirstLine: false, tab: '  ', end: '  ')}${request.isDeprecated ? "@Deprecated('This method is marked as deprecated')\n  " : ''}${request.isMultiPart ? '@MultiPart()\n  ' : ''}${request.isFormUrlEncoded ? '@FormUrlEncoded()\n  ' : ''}@${request.requestType.name.toUpperCase()}('${request.route}')
-  Future<${request.returnType == null ? 'void' : request.returnType!.toSuitableType(ProgrammingLanguage.dart)}> ${request.name}(''',
+  Future<${request.isOriginalHttpResponse ? 'HttpResponse<$responseType>' : responseType}> ${request.name}(''',
   );
   if (request.parameters.isNotEmpty) {
     sb.write('{\n');

swagger_parser/lib/src/parser/parser.dart

@@ -29,11 +29,13 @@ class OpenApiParser {
     bool enumsPrefix = false,
     bool pathMethodName = false,
     bool squashClients = false,
+    bool originalHttpResponse = false,
     List<ReplacementRule> replacementRules = const <ReplacementRule>[],
   })  : _name = name,
         _pathMethodName = pathMethodName,
         _enumsPrefix = enumsPrefix,
         _squashClients = squashClients,
+        _originalHttpResponse = originalHttpResponse,
         _replacementRules = replacementRules {
     _definitionFileContent = isYaml
         ? (loadYaml(fileContent) as YamlMap).toMap()
@@ -62,6 +64,7 @@ class OpenApiParser {
   final bool _enumsPrefix;
   final String? _name;
   final bool _squashClients;
+  final bool _originalHttpResponse;
   final List<ReplacementRule> _replacementRules;
   late final Map<String, dynamic> _definitionFileContent;
   late final OAS _version;
@@ -472,6 +475,7 @@ class OpenApiParser {
           route: path,
           isMultiPart: isMultiPart,
           isFormUrlEncoded: isFormUrlEncoded,
+          isOriginalHttpResponse: _originalHttpResponse,
           returnType: returnType,
           parameters: parameters,
           isDeprecated: requestPath[_deprecatedConst].toString().toBool(),

swagger_parser/pubspec.yaml

@@ -1,6 +1,6 @@
 name: swagger_parser
 description: Package that generates REST clients and data classes from OpenApi definition file
-version: 1.10.2
+version: 1.10.3
 repository: https://github.com/Carapacik/swagger_parser/tree/main/swagger_parser
 homepage: https://omega-r.com
 topics: