Skip to content

Commit

Permalink
[csharp][csharp-netcore] Fix Fileupload for Request Bodies for RestSh…
Browse files Browse the repository at this point in the history 
…arp and HttpClient libraries (#9010)

* Fix Request Body File Upload for RestSharp and csharp-netcore

* Update Samples

* Fix missing using and update samples

* Enable upload test

* Fix form data and file upload handling for httpclient, update samples
  • Loading branch information
@Blackclaws
Blackclaws authored Mar 19, 2021
1 parent 4632624 commit 88fa5d7
Show file tree
Hide file tree
Showing 8 changed files with 242 additions and 129 deletions.
39 changes: 27 additions & 12 deletions modules/openapi-generator/src/main/resources/csharp-netcore/ApiClient.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,25 +331,40 @@ namespace {{packageName}}.Client

if (options.Data != null)
{
if (options.HeaderParameters != null)
if (options.Data is Stream stream)
{
var contentTypes = options.HeaderParameters["Content-Type"];
if (contentTypes == null || contentTypes.Any(header => header.Contains("application/json")))
var contentType = "application/octet-stream";
if (options.HeaderParameters != null)
{
request.RequestFormat = DataFormat.Json;
}
else
{
// TODO: Generated client user should add additional handlers. RestSharp only supports XML and JSON, with XML as default.
var contentTypes = options.HeaderParameters["Content-Type"];
contentType = contentTypes[0];
}

var bytes = ClientUtils.ReadAsBytes(stream);
request.AddParameter(contentType, bytes, ParameterType.RequestBody);
}
else
{
// Here, we'll assume JSON APIs are more common. XML can be forced by adding produces/consumes to openapi spec explicitly.
request.RequestFormat = DataFormat.Json;
}
if (options.HeaderParameters != null)
{
var contentTypes = options.HeaderParameters["Content-Type"];
if (contentTypes == null || contentTypes.Any(header => header.Contains("application/json")))
{
request.RequestFormat = DataFormat.Json;
}
else
{
// TODO: Generated client user should add additional handlers. RestSharp only supports XML and JSON, with XML as default.
}
}
else
{
// Here, we'll assume JSON APIs are more common. XML can be forced by adding produces/consumes to openapi spec explicitly.
request.RequestFormat = DataFormat.Json;
}
request.AddJsonBody(options.Data);
request.AddJsonBody(options.Data);
}
}
if (options.FileParameters != null)
Expand Down
88 changes: 54 additions & 34 deletions ...enapi-generator/src/main/resources/csharp-netcore/libraries/httpclient/ApiClient.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ using ErrorEventArgs = Newtonsoft.Json.Serialization.ErrorEventArgs;
using System.Net.Http;
{{/useWebRequest}}
using System.Net.Http;
using System.Net.Http.Headers;
{{#supportsRetry}}
using Polly;
{{/supportsRetry}}
Expand Down Expand Up @@ -214,6 +215,32 @@ namespace {{packageName}}.Client
{{/reUseHttpClient}}
}

/// Prepares multipart/form-data content
{{! TODO: Add handling of improper usage }}
HttpContent PrepareMultipartFormDataContent(RequestOptions options)
{
string boundary = "---------" + Guid.NewGuid().ToString().ToUpperInvariant();
var multipartContent = new MultipartFormDataContent(boundary);
foreach (var formParameter in options.FormParameters)
{
multipartContent.Add(new StringContent(formParameter.Value), formParameter.Key);
}

if (options.FileParameters != null && options.FileParameters.Count > 0)
{
foreach (var fileParam in options.FileParameters)
{
var fileStream = fileParam.Value as FileStream;
var fileStreamName = fileStream != null ? System.IO.Path.GetFileName(fileStream.Name) : null;
var content = new StreamContent(fileParam.Value);
content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
multipartContent.Add(content, fileParam.Key,
fileStreamName ?? "no_file_name_provided");
}
}
return multipartContent;
}

/// <summary>
/// Provides all logic for constructing a new HttpRequestMessage.
/// At this point, all information for querying the service is known. Here, it is simply
Expand Down Expand Up @@ -270,52 +297,45 @@ namespace {{packageName}}.Client

List<Tuple<HttpContent, string, string>> contentList = new List<Tuple<HttpContent, string, string>>();

if (options.FormParameters != null && options.FormParameters.Count > 0)
string contentType = null;
if (options.HeaderParameters != null && options.HeaderParameters.ContainsKey("Content-Type"))
{
contentList.Add(new Tuple<HttpContent, string, string>(new FormUrlEncodedContent(options.FormParameters), null, null));
var contentTypes = options.HeaderParameters["Content-Type"];
contentType = contentTypes.FirstOrDefault();
}

if (options.Data != null)
{{!// TODO Add error handling in case of improper usage}}
if (contentType == "multipart/form-data")
{
var serializer = new CustomJsonCodec(SerializerSettings, configuration);
contentList.Add(
new Tuple<HttpContent, string, string>(new StringContent(serializer.Serialize(options.Data), new UTF8Encoding(), "application/json"), null, null));
request.Content = PrepareMultipartFormDataContent(options);
}

if (options.FileParameters != null && options.FileParameters.Count > 0)
else if (contentType == "application/x-www-form-urlencoded")
{
foreach (var fileParam in options.FileParameters)
{
var bytes = ClientUtils.ReadAsBytes(fileParam.Value);
var fileStream = fileParam.Value as FileStream;
contentList.Add(new Tuple<HttpContent, string, string>(new ByteArrayContent(bytes), fileParam.Key,
fileStream?.Name ?? "no_file_name_provided"));
}
request.Content = new FormUrlEncodedContent(options.FormParameters);
}

if (contentList.Count > 1)
else
{
string boundary = "---------" + Guid.NewGuid().ToString().ToUpperInvariant();
var multipartContent = new MultipartFormDataContent(boundary);
foreach (var content in contentList)
if (options.Data != null)
{
if(content.Item2 != null)
{
multipartContent.Add(content.Item1, content.Item2, content.Item3);
}
else
{
multipartContent.Add(content.Item1);
}
}
if (options.Data is Stream s)
{
contentType ??= "application/octet-stream";
request.Content = multipartContent;
}
else
{
request.Content = contentList.FirstOrDefault()?.Item1;
var streamContent = new StreamContent(s);
streamContent.Headers.ContentType = new MediaTypeHeaderValue(contentType);
request.Content = streamContent;
}
else
{
var serializer = new CustomJsonCodec(SerializerSettings, configuration);
request.Content = new StringContent(serializer.Serialize(options.Data), new UTF8Encoding(),
"application/json");
}
}
}



// TODO provide an alternative that allows cookies per request instead of per API client
if (options.Cookies != null && options.Cookies.Count > 0)
{
Expand Down
2 changes: 1 addition & 1 deletion ...tore/csharp-netcore/OpenAPIClient-httpclient/src/Org.OpenAPITools.Test/Api/PetApiTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ public void UpdatePetWithFormTest()
/// <summary>
/// Test UploadFile
/// </summary>
[Fact (Skip = "file upload not working for httpclient yet")]
[Fact]
public void UploadFileTest()
{
Assembly _assembly = Assembly.GetExecutingAssembly();
Expand Down
86 changes: 52 additions & 34 deletions ...petstore/csharp-netcore/OpenAPIClient-httpclient/src/Org.OpenAPITools/Client/ApiClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
using Newtonsoft.Json.Serialization;
using ErrorEventArgs = Newtonsoft.Json.Serialization.ErrorEventArgs;
using System.Net.Http;
using System.Net.Http.Headers;
using Polly;

namespace Org.OpenAPITools.Client
Expand Down Expand Up @@ -202,6 +203,31 @@ public ApiClient(String basePath)
_baseUrl = basePath;
}

/// Prepares multipart/form-data content
HttpContent PrepareMultipartFormDataContent(RequestOptions options)
{
string boundary = "---------" + Guid.NewGuid().ToString().ToUpperInvariant();
var multipartContent = new MultipartFormDataContent(boundary);
foreach (var formParameter in options.FormParameters)
{
multipartContent.Add(new StringContent(formParameter.Value), formParameter.Key);
}

if (options.FileParameters != null && options.FileParameters.Count > 0)
{
foreach (var fileParam in options.FileParameters)
{
var fileStream = fileParam.Value as FileStream;
var fileStreamName = fileStream != null ? System.IO.Path.GetFileName(fileStream.Name) : null;
var content = new StreamContent(fileParam.Value);
content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
multipartContent.Add(content, fileParam.Key,
fileStreamName ?? "no_file_name_provided");
}
}
return multipartContent;
}

/// <summary>
/// Provides all logic for constructing a new HttpRequestMessage.
/// At this point, all information for querying the service is known. Here, it is simply
Expand Down Expand Up @@ -258,52 +284,44 @@ private HttpRequestMessage NewRequest(

List<Tuple<HttpContent, string, string>> contentList = new List<Tuple<HttpContent, string, string>>();

if (options.FormParameters != null && options.FormParameters.Count > 0)
string contentType = null;
if (options.HeaderParameters != null && options.HeaderParameters.ContainsKey("Content-Type"))
{
contentList.Add(new Tuple<HttpContent, string, string>(new FormUrlEncodedContent(options.FormParameters), null, null));
var contentTypes = options.HeaderParameters["Content-Type"];
contentType = contentTypes.FirstOrDefault();
}

if (options.Data != null)
if (contentType == "multipart/form-data")
{
var serializer = new CustomJsonCodec(SerializerSettings, configuration);
contentList.Add(
new Tuple<HttpContent, string, string>(new StringContent(serializer.Serialize(options.Data), new UTF8Encoding(), "application/json"), null, null));
request.Content = PrepareMultipartFormDataContent(options);
}

if (options.FileParameters != null && options.FileParameters.Count > 0)
else if (contentType == "application/x-www-form-urlencoded")
{
foreach (var fileParam in options.FileParameters)
{
var bytes = ClientUtils.ReadAsBytes(fileParam.Value);
var fileStream = fileParam.Value as FileStream;
contentList.Add(new Tuple<HttpContent, string, string>(new ByteArrayContent(bytes), fileParam.Key,
fileStream?.Name ?? "no_file_name_provided"));
}
request.Content = new FormUrlEncodedContent(options.FormParameters);
}

if (contentList.Count > 1)
else
{
string boundary = "---------" + Guid.NewGuid().ToString().ToUpperInvariant();
var multipartContent = new MultipartFormDataContent(boundary);
foreach (var content in contentList)
if (options.Data != null)
{
if(content.Item2 != null)
{
multipartContent.Add(content.Item1, content.Item2, content.Item3);
}
else
{
multipartContent.Add(content.Item1);
}
}
if (options.Data is Stream s)
{
contentType ??= "application/octet-stream";

request.Content = multipartContent;
}
else
{
request.Content = contentList.FirstOrDefault()?.Item1;
var streamContent = new StreamContent(s);
streamContent.Headers.ContentType = new MediaTypeHeaderValue(contentType);
request.Content = streamContent;
}
else
{
var serializer = new CustomJsonCodec(SerializerSettings, configuration);
request.Content = new StringContent(serializer.Serialize(options.Data), new UTF8Encoding(),
"application/json");
}
}
}



// TODO provide an alternative that allows cookies per request instead of per API client
if (options.Cookies != null && options.Cookies.Count > 0)
{
Expand Down
39 changes: 27 additions & 12 deletions ...ient/petstore/csharp-netcore/OpenAPIClient-net47/src/Org.OpenAPITools/Client/ApiClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,25 +331,40 @@ private RestRequest NewRequest(

if (options.Data != null)
{
if (options.HeaderParameters != null)
if (options.Data is Stream stream)
{
var contentTypes = options.HeaderParameters["Content-Type"];
if (contentTypes == null || contentTypes.Any(header => header.Contains("application/json")))
var contentType = "application/octet-stream";
if (options.HeaderParameters != null)
{
request.RequestFormat = DataFormat.Json;
}
else
{
// TODO: Generated client user should add additional handlers. RestSharp only supports XML and JSON, with XML as default.
var contentTypes = options.HeaderParameters["Content-Type"];
contentType = contentTypes[0];
}

var bytes = ClientUtils.ReadAsBytes(stream);
request.AddParameter(contentType, bytes, ParameterType.RequestBody);
}
else
{
// Here, we'll assume JSON APIs are more common. XML can be forced by adding produces/consumes to openapi spec explicitly.
request.RequestFormat = DataFormat.Json;
}
if (options.HeaderParameters != null)
{
var contentTypes = options.HeaderParameters["Content-Type"];
if (contentTypes == null || contentTypes.Any(header => header.Contains("application/json")))
{
request.RequestFormat = DataFormat.Json;
}
else
{
// TODO: Generated client user should add additional handlers. RestSharp only supports XML and JSON, with XML as default.
}
}
else
{
// Here, we'll assume JSON APIs are more common. XML can be forced by adding produces/consumes to openapi spec explicitly.
request.RequestFormat = DataFormat.Json;
}

request.AddJsonBody(options.Data);
request.AddJsonBody(options.Data);
}
}

if (options.FileParameters != null)
Expand Down
Loading

0 comments on commit 88fa5d7

Please sign in to comment.