Merge pull request #4 from genusP/feature/multipart

Fix generation for multipart (#3) + Some small fixes

Author: genusP

ApiCodeGenerator.OpenApi.Refit.Tests/ApiCodeGenerator.OpenApi.Refit.Tests.csproj

@@ -19,7 +19,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="ApiCodeGenerator.OpenApi.Sdk" Version="3.0.0-rc.10" />
+    <PackageReference Include="ApiCodeGenerator.OpenApi.Sdk" Version="3.0.0-rc.18" />
     <PackageReference Include="NSwag.Core.Yaml" Version="14.0.2" />
     <PackageReference Include="NSwag.CodeGeneration.CSharp" Version="14.0.2" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.1" />

ApiCodeGenerator.OpenApi.Refit.Tests/FormDataTests.cs

@@ -13,31 +13,34 @@ public class FormDataTests
         [Test]
         public async Task FormData()
         {
-            var json = "{" + OpenApiDocumentDeclaration + @"
-  ""paths"": {
-    ""/test"": {
-      ""post"": {
-        ""operationId"": ""GetTest"",
-        ""requestBody"": {
-            ""content"":{
-                ""multipart/form-data"":{
-                    ""schema"":{
-                        ""type"": ""object"",
-                        ""properties"": {
-                            ""testProp"":{""type"":""string""}
-                        },
-                        ""additionalProperties"": false
-                    },
-                    ""encoding"":{""testProp"": {""style"":""form""}}
+            var json = $$"""
+            {
+                {{OpenApiDocumentDeclaration}}
+                "paths": {
+                    "/test": {
+                        "post": {
+                            "operationId": "GetTest",
+                            "requestBody": {
+                                "content":{
+                                    "application/x-www-form-urlencoded":{
+                                        "schema":{
+                                            "type": "object",
+                                            "properties": {
+                                                "testProp":{"type":"string"}
+                                            },
+                                            "additionalProperties": false
+                                        }
+                                    }
+                                }
+                            },
+                            "responses": {
+                                "200": {"description": "valid input"}
+                            }
+                        }
+                    }
                 }
             }
-        },
-        ""responses"": {
-          ""200"": {""description"": ""valid input""}
-        }
-      }
-    }
-  }}";
+            """;
             var document = await OpenApiDocument.FromJsonAsync(json);
             RefitCodeGeneratorSettings settings = new()
             {
@@ -53,7 +56,7 @@ public async Task FormData()
                 "        /// <returns>valid input</returns>\n" +
                 "        /// <exception cref=\"Refit.ApiException\">A server side error occurred.</exception>\n" +
                 "        [Post(\"/test\")]\n" +
-                $"        System.Threading.Tasks.Task GetTest([Body(BodySerializationMethod.UrlEncoded)]GetTestFormData getTestFormData);\n" +
+                $"        System.Threading.Tasks.Task GetTest([Body(BodySerializationMethod.UrlEncoded)]GetTestFormData body);\n" +
                 "\n" +
                 "    }\n";
             var expectedClassCode =
@@ -66,5 +69,30 @@ public async Task FormData()
                 "    }\n";
             RunTest(settings, expectedInterfaceCode, document, expectedClassCode);
         }
+
+        [Test]
+        public void FileUpload()
+        {
+            //Arrange
+            var settings = new RefitCodeGeneratorSettings
+            {
+                GenerateClientInterfaces = true,
+                CSharpGeneratorSettings = { Namespace = "TestNS" },
+            };
+
+            var expected =
+                "    public partial interface IClient\n" +
+                "    {\n" +
+                "        /// <returns>OK</returns>\n" +
+                "        /// <exception cref=\"Refit.ApiException\">A server side error occurred.</exception>\n" +
+                "        [Multipart]\n" +
+                "        [Post(\"/file\")]\n" +
+                "        System.Threading.Tasks.Task Upload(int? id, StreamPart file, System.Collections.Generic.ICollection<StreamPart> fileArr);\n" +
+                "\n" +
+                "    }\n";
+
+            //Act & Assert
+            RunTest(settings, expected, "multipart.yml", "    \n");
+        }
     }
 }

ApiCodeGenerator.OpenApi.Refit.Tests/FunctionalTests.cs

@@ -63,6 +63,7 @@ public void GenerateClientInterface_Query()
                 "        [Get(\"/testService/testOper\")]\n" +
                 "        System.Threading.Tasks.Task<TestOperResponse> GetTestOper([Header(\"headerParametr\")]string headerParametr, [Query(CollectionFormat.Multi)]System.Collections.Generic.IEnumerable<string> queryParametr, [Query][AliasAs(\"doted.queryParametr\")]string doted_queryParametr);\n" +
                 "\n" +
+                "        /// <returns>OK</returns>\n" +
                 "        /// <exception cref=\"Refit.ApiException\">A server side error occurred.</exception>\n" +
                 "        [Post(\"/testService/testOper\")]\n" +
                 "        System.Threading.Tasks.Task CreateTestOper([Body]string a);\n" +

ApiCodeGenerator.OpenApi.Refit.Tests/swagger/multipart.yml

@@ -0,0 +1,27 @@
+openapi: 3.0.0
+info:
+  title: multipart test schema
+  version: "1"
+paths:
+  /file:
+    post:
+      operationId: upload
+      requestBody:
+        content:
+          "multipart/form-data":
+            schema:
+              type: object
+              properties:
+                id:
+                  type: integer
+                file:
+                  type: string
+                  format: binary
+                fileArr:
+                  type: array
+                  items:
+                    type: string
+                    format: binary
+      responses:
+        "200":
+          description: "OK"

ApiCodeGenerator.OpenApi.Refit.Tests/swagger/testSchema2.json

@@ -13,12 +13,16 @@
     }
   ],
   "paths": {
-    "testService/testOper": {
+    "/testService/testOper": {
       "get": {
-        "tags": [ "testOper" ],
+        "tags": [
+          "testOper"
+        ],
         "summary": "Test operation",
         "operationId": "getTestOperUsingGET",
-        "produces": [ "application/json" ],
+        "produces": [
+          "application/json"
+        ],
         "parameters": [
           {
             "name": "headerParametr",
@@ -33,7 +37,9 @@
             "description": "Параметр передаваемый в строке запроса",
             "required": false,
             "type": "array",
-            "items": { "type": "string" },
+            "items": {
+              "type": "string"
+            },
             "collectionFormat": "multi",
             "allowEmptyValue": false
           },
@@ -56,17 +62,27 @@
         "deprecated": false
       },
       "post": {
-        "tags": [ "testOper" ],
+        "tags": [
+          "testOper"
+        ],
         "operationId": "createTestOperUsingPOST",
         "parameters": [
           {
             "name": "a",
             "in": "body",
-            "type": "string"
+            "schema": {
+              "type": "string"
+            }
           }
         ],
-        "produces": [ "application/json" ],
-        "responses": { "200": {} }
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
       }
     }
   },

ApiCodeGenerator.OpenApi.Refit/ApiCodeGenerator.OpenApi.Refit.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="ApiCodeGenerator.OpenApi.Sdk/3.0.0-rc.10">
+<Project Sdk="ApiCodeGenerator.OpenApi.Sdk/3.0.0-rc.18">
 
   <PropertyGroup>
     <Description>Generates code for the Refit library from an OpenApi document.</Description>

ApiCodeGenerator.OpenApi.Refit/Model/RefitOperationModel.cs

@@ -36,7 +36,7 @@ public RefitOperationModel(OpenApiOperation operation, RefitCodeGeneratorSetting
             _generator = generator;
             _resolver = resolver;
 
-            IEnumerable<OpenApiParameter> parameters = operation.ActualParameters;
+            IEnumerable<OpenApiParameter> parameters = GetActualParameters();
 
             if (Settings.AuthorizationHeaderParameter && RequiresAuthentication)
             {
@@ -58,14 +58,7 @@ public RefitOperationModel(OpenApiOperation operation, RefitCodeGeneratorSetting
 
             Parameters = parameters
                            .Select(parameter =>
-                           {
-                               if (operation.RequestBody?.Content?.ContainsKey("multipart/form-data") == true)
-                               {
-                                   parameter.Style = OpenApiParameterStyle.Form;
-                                   parameter.Name = ConversionUtilities.ConvertToLowerCamelCase($"{Id}FormData", true);
-                               }
-
-                               return new RefitParameterModel(
+                                new RefitParameterModel(
                                    parameter.Name,
                                    GetParameterVariableName(parameter, operation.Parameters),
                                    GetParameterVariableIdentifier(parameter, operation.Parameters),
@@ -74,8 +67,7 @@ public RefitOperationModel(OpenApiOperation operation, RefitCodeGeneratorSetting
                                    operation.Parameters,
                                    Settings.CodeGeneratorSettings,
                                    generator,
-                                   resolver);
-                           })
+                                   resolver))
                            .ToList<CSharpParameterModel>();
         }
 
@@ -179,6 +171,32 @@ internal void InitWrappedQueryParameters()
             }
         }
 
+        protected override string ResolveParameterType(OpenApiParameter parameter)
+        {
+            if (ConsumesFormUrlEncoded && parameter.Kind == OpenApiParameterKind.Body)
+            {
+                var isNullable = parameter.IsRequired == false || parameter.IsNullable(Settings.CodeGeneratorSettings.SchemaType);
+                var typeNameHint = $"{Id}FormData";
+                return _resolver?.Resolve(parameter.ActualSchema, isNullable, typeNameHint);
+            }
+
+            if (_resolver is not null && HasFormParameters)
+            {
+                var typeName = Settings.BinaryPartType;
+                if (parameter.IsBinaryBodyParameter || parameter.ActualSchema.IsBinary)
+                {
+                    return typeName;
+                }
+
+                if (parameter.ActualSchema.IsArray && parameter.ActualSchema.Item.IsBinary)
+                {
+                    return $"{Settings.CSharpGeneratorSettings.ArrayType}<{typeName}>";
+                }
+            }
+
+            return base.ResolveParameterType(parameter);
+        }
+
         private string GetOperationPath()
         {
             return $"{Settings.GenerateControllerName(ControllerName)}.{ActualOperationName}";

ApiCodeGenerator.OpenApi.Refit/RefitCodeGenerator.cs

@@ -30,9 +30,9 @@ public RefitCodeGenerator(OpenApiDocument openApiDocument, RefitCodeGeneratorSet
         {
             OpenApiDocument = openApiDocument;
             _settings = settings;
+            _settings.CSharpGeneratorSettings.ExcludedTypeNames = ["FileParameter", .. _settings.CSharpGeneratorSettings.ExcludedTypeNames];
         }
 
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "internal")]
         internal RefitCodeGenerator(OpenApiDocument openApiDocument, RefitCodeGeneratorSettings settings)
             : this(openApiDocument, settings, CreateResolverWithExceptionSchema(settings.CSharpGeneratorSettings, openApiDocument))
         {

ApiCodeGenerator.OpenApi.Refit/RefitCodeGeneratorSettings.cs

@@ -60,6 +60,11 @@ public RefitCodeGeneratorSettings()
         /// <summary>
         /// Включает генерацию параметра для передачи заголовка авторизации.
         /// </summary>
-        public bool AuthorizationHeaderParameter { get; internal set; }
+        public bool AuthorizationHeaderParameter { get; set; }
+
+        /// <summary>
+        /// Тип используемый для двоичного содержиого.
+        /// </summary>
+        public string BinaryPartType { get; set; } = "StreamPart";
     }
 }

ApiCodeGenerator.OpenApi.Refit/Templates/Client.Interface.Operation.Parameter.liquid

@@ -1,7 +1,7 @@
 {% if parameter.IsHeader -%}
 [Header("{{ parameter.Name }}")]{%- elsif parameter.IsQuery -%}
 [Query{% if parameter.CollectionFormat %}(CollectionFormat.{{ parameter.CollectionFormat }}){% endif %}]{%- elsif parameter.IsBody -%}
-[Body{% if parameter.IsForm %}(BodySerializationMethod.UrlEncoded){% endif %}]{%- endif -%}
+[Body{% if operation.ConsumesFormUrlEncoded %}(BodySerializationMethod.UrlEncoded){% endif %}]{%- endif -%}
 {%- if parameter.IsAliased -%}
 [AliasAs("{{parameter.Name}}")]{% endif -%}
-{{- parameter.Type }} {{ parameter.VariableName }}{% if GenerateOptionalParameters and parameter.IsOptional %} = null{% endif %}
+{{- parameter.Type }} {{ parameter.VariableName }}{% if GenerateOptionalParameters and parameter.IsOptional %} = null{% endif %}

ApiCodeGenerator.OpenApi.Refit/Templates/Client.Method.Annotations.liquid

@@ -1,4 +1,7 @@
 {%- for errorResponse in operation.ErrorResponses -%}
 [ErrorResponse(typeof({{ errorResponse.Type }}), {{ errorResponse.StatusCode }})]
 {%- endfor -%}
-[{{ operation.HttpMethodUpper }}("/{{ operation.Path }}")]
+{%- if operation.HasFormParameters and operation.ConsumesFormUrlEncoded == false  -%}
+[Multipart]
+{% endif -%}
+[{{ operation.HttpMethodUpper }}("/{{ operation.Path }}")]