[csharp-netcore] [HttpClient] Refactored Models

modules/openapi-generator/src/main/resources/csharp-netcore/libraries/httpclient/ApiException.mustache

@@ -22,21 +22,21 @@ namespace {{packageName}}.Client
         /// <summary>
         /// The raw data returned by the api
         /// </summary>
-        public string RawData { get; }
+        public string RawContent { get; }
 
         /// <summary>
         /// Construct the ApiException from parts of the reponse
         /// </summary>
         /// <param name="reasonPhrase"></param>
         /// <param name="statusCode"></param>
-        /// <param name="rawData"></param>
-        public ApiException(string? reasonPhrase, System.Net.HttpStatusCode statusCode, string rawData) : base(reasonPhrase ?? rawData)
+        /// <param name="rawContent"></param>
+        public ApiException(string? reasonPhrase, System.Net.HttpStatusCode statusCode, string rawContent) : base(reasonPhrase ?? rawContent)
         {
             ReasonPhrase = reasonPhrase;
 
             StatusCode = statusCode;
 
-            RawData = rawData;
+            RawContent = rawContent;
         }
     }
 }

modules/openapi-generator/src/main/resources/csharp-netcore/libraries/httpclient/ApiResponse.mustache

@@ -31,20 +31,20 @@ namespace {{packageName}}.Client
         /// <summary>
         /// The raw content of this response
         /// </summary>
-        string RawData { get; }
+        string RawContent { get; }
     }
 
     /// <summary>
     /// API Response
     /// </summary>
-    public class ApiResponse<T> : IApiResponse
+    {{>visibility}} partial class ApiResponse<T> : IApiResponse
     {
         #region Properties
 
         /// <summary>
-        /// The deserialized data
+        /// The deserialized content
         /// </summary>
-        public T? Data { get; set; }
+        public T??? Content { get; set; }
 
         /// <summary>
         /// Gets or sets the status code (HTTP status code)
@@ -68,7 +68,7 @@ namespace {{packageName}}.Client
         /// <summary>
         /// The raw data
         /// </summary>
-        public string RawData { get; }
+        public string RawContent { get; }
 
         /// <summary>
         /// The IsSuccessStatusCode from the api response
@@ -78,7 +78,7 @@ namespace {{packageName}}.Client
         /// <summary>
         /// The reason phrase contained in the api response
         /// </summary>
-        public string? ReasonPhrase { get; }
+        public string??? ReasonPhrase { get; }
 
         /// <summary>
         /// The headers contained in the api response
@@ -91,14 +91,14 @@ namespace {{packageName}}.Client
         /// Construct the reponse using an HttpResponseMessage
         /// </summary>
         /// <param name="response"></param>
-        /// <param name="rawData"></param>
-        public ApiResponse(System.Net.Http.HttpResponseMessage response, string rawData)
+        /// <param name="rawContent"></param>
+        public ApiResponse(System.Net.Http.HttpResponseMessage response, string rawContent)
         {
             StatusCode = response.StatusCode;
             Headers = response.Headers;
             IsSuccessStatusCode = response.IsSuccessStatusCode;
             ReasonPhrase = response.ReasonPhrase;
-            RawData = rawData;
+            RawContent = rawContent;
         }
     }
 }

modules/openapi-generator/src/main/resources/csharp-netcore/libraries/httpclient/AssemblyInfo.mustache

@@ -0,0 +1,37 @@
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+// General Information about an assembly is controlled through the following
+// set of attributes. Change these attribute values to modify the information
+// associated with an assembly.
+[assembly: AssemblyTitle("{{packageTitle}}")]
+[assembly: AssemblyDescription("{{packageDescription}}")]
+[assembly: AssemblyConfiguration("")]
+[assembly: AssemblyCompany("{{packageCompany}}")]
+[assembly: AssemblyProduct("{{packageProductName}}")]
+[assembly: AssemblyCopyright("{{packageCopyright}}")]
+[assembly: AssemblyTrademark("")]
+[assembly: AssemblyCulture("")]
+
+// Setting ComVisible to false makes the types in this assembly not visible
+// to COM components.  If you need to access a type in this assembly from
+// COM, set the ComVisible attribute to true on that type.
+[assembly: ComVisible(false)]
+
+// Version information for an assembly consists of the following four values:
+//
+//      Major Version
+//      Minor Version
+//      Build Number
+//      Revision
+//
+// You can specify all the values or you can default the Build and Revision Numbers
+// by using the '*' as shown below:
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("{{packageVersion}}")]
+[assembly: AssemblyFileVersion("{{packageVersion}}")]
+{{^supportsAsync}}
+[assembly: InternalsVisibleTo("NewtonSoft.Json")]
+[assembly: InternalsVisibleTo("JsonSubTypes")]
+{{/supportsAsync}}

modules/openapi-generator/src/main/resources/csharp-netcore/libraries/httpclient/README.mustache

@@ -0,0 +1,252 @@
+This library requires some post procesing. You can use this PowerShell script to run the generator and process the results.
+
+If you are not using .Net Standard, consider setting validatable to false in your generator-config.json due to this bug: https://github.com/dotnet/project-system/issues/3934
+
+```
+java -jar "../openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar" generate `
+    -g csharp-netcore `
+    -i "your-swagger-file.yml" `
+    -c generator-config.json `
+    -o output `
+    -t templates `
+    --library httpclient
+
+$files = Get-ChildItem output -Recurse | Where-Object {-Not($_.PSIsContainer)}
+foreach ($file in $files)
+{
+    $content=Get-Content $file.PSPath
+
+    if (-Not($content)){
+        continue;
+    }
+
+    # if null reference types are enabled
+    $content=$content -replace '\?{3,4}', '?' # replace every three to four consecutive occurrences of '?' with a single one
+
+    # if null reference types are not enabled
+    # $content=$content.Replace("????", "?") # reference type
+    # $content=$content.Replace("???", "") # value type
+
+    Set-Content $file.PSPath $content    
+}
+```
+
+# {{packageName}} - the C# library for the {{appName}}
+
+{{#appDescriptionWithNewLines}}
+{{{appDescriptionWithNewLines}}}
+{{/appDescriptionWithNewLines}}
+
+This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: {{appVersion}}
+- SDK version: {{packageVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+    For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+<a name="frameworks-supported"></a>
+## Frameworks supported
+{{#netStandard}}
+- .NET Core >=1.0
+- .NET Framework >=4.6
+- Mono/Xamarin >=vNext
+{{/netStandard}}
+
+<a name="dependencies"></a>
+## Dependencies
+
+- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 12.0.3 or later
+- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.7.0 or later
+{{#useCompareNetObjects}}
+- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
+{{/useCompareNetObjects}}
+{{#validatable}}
+- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
+{{/validatable}}
+
+The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
+```
+Install-Package Newtonsoft.Json
+Install-Package JsonSubTypes
+{{#validatable}}
+Install-Package System.ComponentModel.Annotations
+{{/validatable}}
+{{#useCompareNetObjects}}
+Install-Package CompareNETObjects
+{{/useCompareNetObjects}}
+```
+
+<a name="installation"></a>
+## Installation
+{{#netStandard}}
+Generate the DLL using your preferred tool (e.g. `dotnet build`)
+{{/netStandard}}
+{{^netStandard}}
+Run the following command to generate the DLL
+- [Mac/Linux] `/bin/sh build.sh`
+- [Windows] `build.bat`
+{{/netStandard}}
+
+Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces:
+```csharp
+using {{packageName}}.{{apiPackage}};
+using {{packageName}}.Client;
+using {{packageName}}.{{modelPackage}};
+```
+{{^netStandard}}
+<a name="packaging"></a>
+## Packaging
+
+A `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) packages.
+
+This `.nuspec` uses placeholders from the `.csproj`, so build the `.csproj` directly:
+
+```
+nuget pack -Build -OutputDirectory out {{packageName}}.csproj
+```
+
+Then, publish to a [local feed](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual.
+
+{{/netStandard}}
+<a name="usage"></a>
+## Usage
+
+To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
+```csharp
+Configuration c = new Configuration();
+System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
+webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
+c.Proxy = webProxy;
+```
+
+<a name="getting-started"></a>
+## Getting Started
+
+```csharp
+using System.Collections.Generic;
+using System.Diagnostics;
+using {{packageName}}.{{apiPackage}};
+using {{packageName}}.Client;
+using {{packageName}}.{{modelPackage}};
+
+namespace Example
+{
+    public class {{operationId}}Example
+    {
+        public static void Main()
+        {
+{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}
+            Configuration config = new Configuration();
+            config.BasePath = "{{{basePath}}}";
+            {{#hasAuthMethods}}
+            {{#authMethods}}
+            {{#isBasicBasic}}
+            // Configure HTTP basic authorization: {{{name}}}
+            config.Username = "YOUR_USERNAME";
+            config.Password = "YOUR_PASSWORD";
+            {{/isBasicBasic}}
+            {{#isBasicBearer}}
+            // Configure Bearer token for authorization: {{{name}}}
+            config.AccessToken = "YOUR_BEARER_TOKEN";
+            {{/isBasicBearer}}
+            {{#isApiKey}}
+            // Configure API key authorization: {{{name}}}
+            config.ApiKey.Add("{{{keyParamName}}}", "YOUR_API_KEY");
+            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+            // config.ApiKeyPrefix.Add("{{{keyParamName}}}", "Bearer");
+            {{/isApiKey}}
+            {{#isOAuth}}
+            // Configure OAuth2 access token for authorization: {{{name}}}
+            config.AccessToken = "YOUR_ACCESS_TOKEN";
+            {{/isOAuth}}
+            {{/authMethods}}
+
+            {{/hasAuthMethods}}
+            var apiInstance = new {{classname}}(config);
+            {{#allParams}}
+            {{#isPrimitiveType}}
+            var {{paramName}} = {{{example}}};  // {{{dataType}}} | {{{description}}}{{^required}} (optional) {{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+            {{/isPrimitiveType}}
+            {{^isPrimitiveType}}
+            var {{paramName}} = new {{{dataType}}}(); // {{{dataType}}} | {{{description}}}{{^required}} (optional) {{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+            {{/isPrimitiveType}}
+            {{/allParams}}
+
+            try
+            {
+                {{#summary}}
+                // {{{.}}}
+                {{/summary}}
+                {{#returnType}}{{{returnType}}} result = {{/returnType}}apiInstance.{{{operationId}}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});{{#returnType}}
+                Debug.WriteLine(result);{{/returnType}}
+            }
+            catch (ApiException e)
+            {
+                Debug.Print("Exception when calling {{classname}}.{{operationId}}: " + e.Message );
+                Debug.Print("Status Code: "+ e.ErrorCode);
+                Debug.Print(e.StackTrace);
+            }
+{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
+        }
+    }
+}
+```
+
+<a name="documentation-for-api-endpoints"></a>
+## Documentation for API Endpoints
+
+All URIs are relative to *{{{basePath}}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+<a name="documentation-for-models"></a>
+## Documentation for Models
+
+{{#modelPackage}}
+{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
+{{/model}}{{/models}}
+{{/modelPackage}}
+{{^modelPackage}}
+No model defined in this package
+{{/modelPackage}}
+
+<a name="documentation-for-authorization"></a>
+## Documentation for Authorization
+
+{{^authMethods}}
+All endpoints do not require authorization.
+{{/authMethods}}
+{{#authMethods}}
+{{#last}}
+Authentication schemes defined for the API:
+{{/last}}
+{{/authMethods}}
+{{#authMethods}}
+<a name="{{name}}"></a>
+### {{name}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{keyParamName}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasicBasic}}- **Type**: HTTP basic authentication
+{{/isBasicBasic}}
+{{#isBasicBearer}}- **Type**: Bearer Authentication
+{{/isBasicBearer}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}}  - {{scope}}: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}