pass json serializer options to http extension methods

Author: erinnmclaughlin

README.md

@@ -14,7 +14,7 @@
 ## Installation
 Download from [NuGet](https://www.nuget.org/packages/Tizzani.QueryStringSerializer).
 ```
-dotnet add package Tizzani.QueryStringSerializer --version 9.0.0
+dotnet add package Tizzani.QueryStringSerializer --version 9.1.1
 ```
 
 ## Example Usage

src/Tizzani.QueryStringSerializer.Blazor/Tizzani.QueryStringSerializer.Blazor.csproj

@@ -9,7 +9,7 @@
     <Copyright>2025 Erin McLaughlin</Copyright>
     <RepositoryUrl>https://github.com/erinnmclaughlin/Tizzani.QueryStringSerializer</RepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <Version>9.1.0</Version>
+    <Version>9.2.0-preview1</Version>
     <PackageIcon>QssBlazorLogo.png</PackageIcon>
   </PropertyGroup>
 

src/Tizzani.QueryStringSerializer/HttpClientExtensions.cs

@@ -1,9 +1,13 @@
 using System.Diagnostics.CodeAnalysis;
+using System.Text.Json;
 using Tizzani.QueryStringSerializer;
 
 // ReSharper disable once CheckNamespace
 namespace System.Net.Http.Json;
 
+/// <summary>
+/// Extension methods for <see cref="HttpClient"/> to support query string serialization.
+/// </summary>
 public static class HttpClientExtensions
 {
     /// <summary>
@@ -14,13 +18,35 @@ public static class HttpClientExtensions
     /// <param name="requestQuery">The object that should be serialized to the request query string.</param>
     /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
     /// <returns>The response message.</returns>
+    public static Task<HttpResponseMessage> GetWithQueryAsync(
+        this HttpClient client,
+        [StringSyntax("Uri")] string requestUri,
+        object? requestQuery,
+        CancellationToken cancellationToken = default) =>
+        client.GetWithQueryAsync(
+            requestUri, 
+            requestQuery, 
+            QueryStringSerializer.DefaultSerializerOptions,
+            cancellationToken
+        );
+    
+    /// <summary>
+    /// Sends a GET request to the specified URL.
+    /// </summary>
+    /// <param name="client">The client used to send the request.</param>
+    /// <param name="requestUri">The URI the request is sent to.</param>
+    /// <param name="requestQuery">The object that should be serialized to the request query string.</param>
+    /// <param name="jsonSerializerOptions">The <see cref="JsonSerializerOptions"/> to use for serialization.</param>
+    /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+    /// <returns>The response message.</returns>
     public static async Task<HttpResponseMessage> GetWithQueryAsync(
         this HttpClient client,
         [StringSyntax("Uri")] string requestUri,
         object? requestQuery,
+        JsonSerializerOptions jsonSerializerOptions,
         CancellationToken cancellationToken = default)
     {
-        var uri = QueryStringSerializer.Serialize(requestUri, requestQuery);
+        var uri = QueryStringSerializer.Serialize(requestUri, requestQuery, jsonSerializerOptions);
         return await client.GetAsync(uri, cancellationToken);
     }
 
@@ -33,13 +59,36 @@ public static async Task<HttpResponseMessage> GetWithQueryAsync(
     /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
     /// <typeparam name="T">The type to deserialize to.</typeparam>
     /// <returns>The deserialized response.</returns>
+    public static Task<T?> GetFromJsonWithQueryAsync<T>(
+        this HttpClient client,
+        [StringSyntax("Uri")] string requestUri,
+        object? requestQuery,
+        CancellationToken cancellationToken = default) =>
+        client.GetFromJsonWithQueryAsync<T>(
+            requestUri,
+            requestQuery,
+            QueryStringSerializer.DefaultSerializerOptions, 
+            cancellationToken
+        );
+    
+    /// <summary>
+    /// Sends a GET request to the specified URL and deserializes the response into an object of type <typeparamref name="T"/>.
+    /// </summary>
+    /// <param name="client">The client used to send the request.</param>
+    /// <param name="requestUri">The URI the request is sent to.</param>
+    /// <param name="requestQuery">The object that should be serialized to the request query string.</param>
+    /// <param name="jsonSerializerOptions">The <see cref="JsonSerializerOptions"/> to use for serialization.</param>
+    /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+    /// <typeparam name="T">The type to deserialize to.</typeparam>
+    /// <returns>The deserialized response.</returns>
     public static async Task<T?> GetFromJsonWithQueryAsync<T>(
         this HttpClient client,
         [StringSyntax("Uri")] string requestUri,
         object? requestQuery,
+        JsonSerializerOptions jsonSerializerOptions,
         CancellationToken cancellationToken = default)
     {
-        var uri = QueryStringSerializer.Serialize(requestUri, requestQuery);
-        return await client.GetFromJsonAsync<T>(uri, cancellationToken);
+        var uri = QueryStringSerializer.Serialize(requestUri, requestQuery, jsonSerializerOptions);
+        return await client.GetFromJsonAsync<T>(uri, jsonSerializerOptions, cancellationToken);
     }
 }

src/Tizzani.QueryStringSerializer/QueryStringSerializer.cs

@@ -11,43 +11,43 @@ namespace Tizzani.QueryStringSerializer;
 
 public static class QueryStringSerializer
 {
+    internal static readonly JsonSerializerOptions DefaultSerializerOptions;
+
+    static QueryStringSerializer()
+    {
+        DefaultSerializerOptions = new JsonSerializerOptions();
+        DefaultSerializerOptions.Converters.Add(new JsonStringEnumConverter());
+    }
+    
     /// <summary>
     /// Serializes an object into a query string format.
     /// </summary>
     /// <param name="uri">The destination URI.</param>
     /// <param name="obj">The object to serialize into a query string.</param>
-    /// <param name="options">The options to use for serialization.</param>
-    /// <typeparam name="T">The type being serialized.</typeparam>
+    /// <param name="jsonSerializerOptions">The <see cref="JsonSerializerOptions"/> to use for serialization.</param>
     /// <returns>The resulting uri and query string.</returns>
-    public static string Serialize<T>(
+    public static string Serialize(
         [StringSyntax("Uri")] string uri,
-        T? obj,
-        JsonSerializerOptions? options = null)
+        object? obj,
+        JsonSerializerOptions? jsonSerializerOptions = null)
     {
-        return obj is null ? uri : $"{uri}?{Serialize(obj, options)}";
+        return obj is null ? uri : $"{uri}?{Serialize(obj, jsonSerializerOptions)}";
     }
 
     /// <summary>
     /// Serializes an object into a query string format.
     /// </summary>
     /// <param name="obj">The object to serialize into a query string.</param>
-    /// <param name="options">The options to use for serialization.</param>
-    /// <typeparam name="T">The type being serialized.</typeparam>
+    /// <param name="jsonSerializerOptions">The <see cref="JsonSerializerOptions"/> to use for serialization.</param>
     /// <returns>The resulting uri and query string.</returns>
-    public static string Serialize<T>(
-        T? obj,
-        JsonSerializerOptions? options = null)
+    public static string Serialize(
+        object? obj,
+        JsonSerializerOptions? jsonSerializerOptions = null)
     {
         if (obj is null) 
             return "";
-
-        if (options == null)
-        {
-            options = new JsonSerializerOptions();
-            options.Converters.Add(new JsonStringEnumConverter());
-        }
 
-        var json = JsonSerializer.Serialize(obj, options);
+        var json = JsonSerializer.Serialize(obj, jsonSerializerOptions ?? DefaultSerializerOptions);
 
         var jObject = JsonNode.Parse(json);
         return ParseToken(jObject);
@@ -57,24 +57,20 @@ public static string Serialize<T>(
     /// Deserializes a query string into an object of the specified type.
     /// </summary>
     /// <param name="uri">The uri that contains the query string.</param>
-    /// <param name="options">The options to use for deserialization.</param>
+    /// <param name="jsonSerializerOptions">The <see cref="JsonSerializerOptions"/> to use for serialization.</param>
     /// <typeparam name="T">The type to deserialize to.</typeparam>
     /// <returns></returns>
     public static T? Deserialize<T>(
         [StringSyntax("Uri")] string uri, 
-        JsonSerializerOptions? options = null)
+        JsonSerializerOptions? jsonSerializerOptions = null)
     {
-        if (options == null)
-        {
-            options = new JsonSerializerOptions();
-            options.Converters.Add(new JsonStringEnumConverter());
-        }
+        jsonSerializerOptions ??= DefaultSerializerOptions;
 
         var qs = uri.Contains('?') ? uri.Split('?')[1] : uri;
         var qParams = QueryHelpers.ParseQuery(qs);
-        var dict = GetObjectDictionary(typeof(T), qParams, options);
-        var json = JsonSerializer.Serialize(dict, options);
-        return JsonSerializer.Deserialize<T>(json, options);
+        var dict = GetObjectDictionary(typeof(T), qParams, jsonSerializerOptions);
+        var json = JsonSerializer.Serialize(dict, jsonSerializerOptions);
+        return JsonSerializer.Deserialize<T>(json, jsonSerializerOptions);
     }
 
     private static Dictionary<string, object?> GetObjectDictionary(Type objectType, Dictionary<string, StringValues> qParams, JsonSerializerOptions jsonSerializerOptions)

src/Tizzani.QueryStringSerializer/Tizzani.QueryStringSerializer.csproj

@@ -11,7 +11,7 @@
     <Copyright>2025 Erin McLaughlin</Copyright>
     <Description>Tizzani.QueryStringHelpers provides methods for serializing &amp; deserializing objects as URL-encoded query strings.</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <Version>9.1.0</Version>
+    <Version>9.2.0-preview1</Version>
     <Title>$(AssemblyName)</Title>
     <PackageIcon>QssLogo.png</PackageIcon>
     <PackageProjectUrl>https://github.com/erinnmclaughlin/Tizzani.QueryStringSerializer</PackageProjectUrl>