Add support for customizing the default Integer format

.github/copilot-instructions.md

@@ -151,6 +151,7 @@ dotnet run --project src/Refitter --configuration Release --framework net9.0 --
 - `--disposable`: Generate IDisposable clients
 - `--collection-format`: Control query parameter collection formatting (Multi/Csv/Ssv/Tsv/Pipes)
 - `--no-banner`: Hide donation banner in CLI output
+- `--integer-type`: Set the .NET type for OpenAPI integers without a format specifier (Int32/Int64)
 
 ### Working with OpenAPI Specifications
 - Test resources are located in `src/Refitter.Tests/Resources/V2/` and `src/Refitter.Tests/Resources/V3/`

README.md

@@ -134,6 +134,7 @@ OPTIONS:
                                                                  See https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism for more information
         --disposable                                             Generate refit clients that implement IDisposable
         --no-inline-json-converters                              Don't inline JsonConverter attributes for enum properties. When disabled, enum properties will not have [JsonConverter(typeof(JsonStringEnumConverter))] attributes
+        --integer-type                           int             The .NET type to use for OpenAPI integer types without a format specifier. Common values: 'int' (default), 'long'
 ```
 
 To generate code from an OpenAPI specifications file, run the following:
@@ -291,6 +292,7 @@ The following is an example `.refitter` file
     "dictionaryInstanceType": "System.Collections.Generic.Dictionary",
     "arrayBaseType": "System.Collections.ObjectModel.Collection",
     "dictionaryBaseType": "System.Collections.Generic.Dictionary",
+    "integerType": "Int32", // Optional. Default="Int32". The .NET type for OpenAPI integers without a format. Possible values: "Int32", "Int64"
     "propertySetterAccessModifier": "",
     "generateImmutableArrayProperties": false,
     "generateImmutableDictionaryProperties": false,
@@ -378,6 +380,7 @@ The following is an example `.refitter` file
   - `dictionaryInstanceType` - Default is `System.Collections.Generic.Dictionary`,
   - `arrayBaseType` - Default is `System.Collections.ObjectModel.Collection`,
   - `dictionaryBaseType` - Default is `System.Collections.Generic.Dictionary`,
+  - `integerType` - Default is `Int32`. The .NET type to use for OpenAPI integer types without a format specifier. Possible values: `Int32`, `Int64`
   - `propertySetterAccessModifier` - Default is ``,
   - `generateImmutableArrayProperties` - Default is false,
   - `generateImmutableDictionaryProperties` - Default is false,

docs/docfx_project/articles/cli-tool.md

@@ -42,6 +42,7 @@ EXAMPLES:
     refitter ./openapi.json --collection-format Csv
     refitter ./openapi.json --simple-output
     refitter ./openapi.json --no-inline-json-converters
+    refitter ./openapi.json --integer-type long
 
 ARGUMENTS:
     [URL or input file]    URL or file path to OpenAPI Specification file
@@ -118,6 +119,7 @@ OPTIONS:
                                                                  See https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism for more information
         --disposable                                             Generate refit clients that implement IDisposable
         --no-inline-json-converters                              Don't inline JsonConverter attributes for enum properties. When disabled, enum properties will not have [JsonConverter(typeof(JsonStringEnumConverter))] attributes
+        --integer-type                           int             The .NET type to use for OpenAPI integer types without a format specifier. Common values: 'int' (default), 'long'
 ```
 
 ## CLI Tool Output Example

docs/docfx_project/articles/refitter-file-format.md

@@ -99,6 +99,7 @@ The following is an example `.refitter` file
     "dictionaryInstanceType": "System.Collections.Generic.Dictionary",
     "arrayBaseType": "System.Collections.ObjectModel.Collection",
     "dictionaryBaseType": "System.Collections.Generic.Dictionary",
+    "integerType": "Int32", // Optional. Default="Int32". The .NET type for OpenAPI integers without a format. Possible values: "Int32", "Int64"
     "propertySetterAccessModifier": "",
     "generateImmutableArrayProperties": false,
     "generateImmutableDictionaryProperties": false,
@@ -192,6 +193,7 @@ The following is an example `.refitter` file
   - `dictionaryInstanceType` - Default is `System.Collections.Generic.Dictionary`,
   - `arrayBaseType` - Default is `System.Collections.ObjectModel.Collection`,
   - `dictionaryBaseType` - Default is `System.Collections.Generic.Dictionary`,
+  - `integerType` - Default is `Int32`. The .NET type to use for OpenAPI integer types without a format specifier. Possible values: `Int32`, `Int64`
   - `propertySetterAccessModifier` - Default is ``,
   - `generateImmutableArrayProperties` - Default is false,
   - `generateImmutableDictionaryProperties` - Default is false,

docs/json-schema.json

@@ -103,6 +103,11 @@
           "description": "Gets or sets the generic dictionary .NET type which is used as base class (default: 'Dictionary').",
           "type": "string"
         },
+        "integerType": {
+          "description": "Gets or sets the .NET type for OpenAPI integers without a format specifier (default: Int32). Possible values: Int32, Int64.",
+          "type": "string",
+          "enum": ["Int32", "Int64"]
+        },
         "propertySetterAccessModifier": {
           "description": "Gets the access modifier of property setters (default: '').",
           "type": "string"

src/Refitter.Core/CSharpClientGeneratorFactory.cs

@@ -1,4 +1,5 @@
 using System.Reflection;
+using NJsonSchema;
 using NJsonSchema.CodeGeneration;
 using NJsonSchema.CodeGeneration.CSharp;
 using NSwag;
@@ -18,6 +19,8 @@ public CustomCSharpClientGenerator Create()
             }
         }
 
+        ApplyCustomIntegerType();
+
         var csharpClientGeneratorSettings = new CSharpClientGeneratorSettings
         {
             GenerateClientClasses = false,
@@ -60,6 +63,97 @@ public CustomCSharpClientGenerator Create()
         return generator;
     }
 
+    private void ApplyCustomIntegerType()
+    {
+        var customIntegerType = settings.CodeGeneratorSettings?.IntegerType ?? IntegerType.Int32;
+        if (customIntegerType == IntegerType.Int32)
+            return;
+
+        ProcessSchemasForIntegerType(document.Components.Schemas);
+
+        foreach (var path in document.Paths)
+        {
+            foreach (var operation in path.Value.Values)
+            {
+                if (operation == null) continue;
+
+                foreach (var parameter in operation.Parameters)
+                {
+                    if (parameter.ActualSchema.Type == JsonObjectType.Integer &&
+                        string.IsNullOrEmpty(parameter.ActualSchema.Format))
+                    {
+                        parameter.ActualSchema.Format = "int64";
+                    }
+                }
+
+                if (operation.RequestBody?.Content != null)
+                {
+                    foreach (var content in operation.RequestBody.Content.Values)
+                    {
+                        ProcessSchemaForIntegerType(content.Schema);
+                    }
+                }
+
+                foreach (var response in operation.Responses.Values)
+                {
+                    if (response.Content != null)
+                    {
+                        foreach (var content in response.Content.Values)
+                        {
+                            ProcessSchemaForIntegerType(content.Schema);
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    private void ProcessSchemasForIntegerType(IDictionary<string, JsonSchema> schemas)
+    {
+        foreach (var schema in schemas.Values)
+        {
+            ProcessSchemaForIntegerType(schema);
+        }
+    }
+
+    private void ProcessSchemaForIntegerType(JsonSchema? schema)
+    {
+        if (schema == null) return;
+
+        var actualSchema = schema.ActualSchema;
+
+        if (actualSchema.Type == JsonObjectType.Integer &&
+            string.IsNullOrEmpty(actualSchema.Format))
+        {
+            actualSchema.Format = "int64";
+        }
+
+        foreach (var property in actualSchema.Properties.Values)
+        {
+            ProcessSchemaForIntegerType(property);
+        }
+
+        if (actualSchema.Item != null)
+        {
+            ProcessSchemaForIntegerType(actualSchema.Item);
+        }
+
+        if (actualSchema.AdditionalPropertiesSchema != null)
+        {
+            ProcessSchemaForIntegerType(actualSchema.AdditionalPropertiesSchema);
+        }
+
+        var subSchemas = actualSchema.AllOf
+            .Concat(actualSchema.OneOf)
+            .Concat(actualSchema.AnyOf)
+            .ToArray();
+
+        foreach (var subSchema in subSchemas)
+        {
+            ProcessSchemaForIntegerType(subSchema);
+        }
+    }
+
     private static void MapCSharpGeneratorSettings(
         CodeGeneratorSettings? source,
         CSharpGeneratorSettings destination)

src/Refitter.Core/IntegerType.cs

@@ -0,0 +1,18 @@
+namespace Refitter.Core;
+
+/// <summary>
+/// Specifies the .NET type to use for OpenAPI integer types
+/// without a format specifier
+/// </summary>
+public enum IntegerType
+{
+    /// <summary>
+    /// Use System.Int32 (int) for integers without format
+    /// </summary>
+    Int32,
+
+    /// <summary>
+    /// Use System.Int64 (long) for integers without format
+    /// </summary>
+    Int64
+}

src/Refitter.Core/Settings/CodeGeneratorSettings.cs

@@ -58,6 +58,12 @@ Gets or sets a value indicating whether a required property must be defined in J
     [Description("Gets or sets the time span .NET type (default: 'TimeSpan').")]
     public string TimeSpanType { get; set; } = "System.TimeSpan";
 
+    /// <summary>
+    /// Gets or sets the .NET type for OpenAPI integers without a format specifier (default: Int32).
+    /// </summary>
+    [Description("Gets or sets the .NET type for OpenAPI integers without a format specifier (default: Int32).")]
+    public IntegerType IntegerType { get; set; } = IntegerType.Int32;
+
     /// <summary>
     /// Gets or sets the generic array .NET type (default: 'ICollection').
     /// </summary>

src/Refitter.MSBuild/README.md

@@ -105,6 +105,7 @@ The following is an example `.refitter` file
     "dictionaryInstanceType": "System.Collections.Generic.Dictionary",
     "arrayBaseType": "System.Collections.ObjectModel.Collection",
     "dictionaryBaseType": "System.Collections.Generic.Dictionary",
+    "integerType": "Int32", // Optional. Default="Int32". The .NET type for OpenAPI integers without a format. Possible values: "Int32", "Int64"
     "propertySetterAccessModifier": "",
     "generateImmutableArrayProperties": false,
     "generateImmutableDictionaryProperties": false,
@@ -181,6 +182,7 @@ The following is an example `.refitter` file
   - `dictionaryInstanceType` - Default is `System.Collections.Generic.Dictionary`,
   - `arrayBaseType` - Default is `System.Collections.ObjectModel.Collection`,
   - `dictionaryBaseType` - Default is `System.Collections.Generic.Dictionary`,
+  - `integerType` - Default is `Int32`. The .NET type to use for OpenAPI integer types without a format specifier. Possible values: `Int32`, `Int64`
   - `propertySetterAccessModifier` - Default is ``,
   - `generateImmutableArrayProperties` - Default is false,
   - `generateImmutableDictionaryProperties` - Default is false,

src/Refitter.SourceGenerator/README.md

@@ -101,6 +101,7 @@ The following is an example `.refitter` file
     "dictionaryInstanceType": "System.Collections.Generic.Dictionary",
     "arrayBaseType": "System.Collections.ObjectModel.Collection",
     "dictionaryBaseType": "System.Collections.Generic.Dictionary",
+    "integerType": "int", // Optional. Default="int". The .NET type for OpenAPI integers without a format. Common values: "int", "long"
     "propertySetterAccessModifier": "",
     "generateImmutableArrayProperties": false,
     "generateImmutableDictionaryProperties": false,
@@ -179,6 +180,7 @@ The following is an example `.refitter` file
   - `dictionaryInstanceType` - Default is `System.Collections.Generic.Dictionary`,
   - `arrayBaseType` - Default is `System.Collections.ObjectModel.Collection`,
   - `dictionaryBaseType` - Default is `System.Collections.Generic.Dictionary`,
+  - `integerType` - Default is `int`. The .NET type to use for OpenAPI integer types without a format specifier. Common values: `int`, `long`
   - `propertySetterAccessModifier` - Default is ``,
   - `generateImmutableArrayProperties` - Default is false,
   - `generateImmutableDictionaryProperties` - Default is false,