🦓 Improve API

- Drop the unnecessary OOCv1ApiClient<T>.
- Use STJ source generation.
- Bump version to 1.3.0.

Author: database64128

README.md

@@ -18,14 +18,14 @@
 
 ``` cs
 // Serialize an API token.
-var token = new OOCv1ApiToken(1, "https://example.com", "8c1da4d8-8684-4a2c-9abb-57b9d5fa7e52", "a117460e-41df-4dbd-b2df-4bd0c16efd2f", null);
-var json = JsonSerializer.Serialize(token, JsonHelper.camelCaseMinifiedJsonSerializerOptions);
+OOCv1ApiToken token = new(1, "https://example.com", "8c1da4d8-8684-4a2c-9abb-57b9d5fa7e52", "a117460e-41df-4dbd-b2df-4bd0c16efd2f", null);
+string json = JsonSerializer.Serialize(token, OOCv1JsonSerializerContext.Default.OOCv1ApiToken);
 ```
 
 ``` cs
 // Deserialize an API token.
-var json = "{\"version\":1,\"baseUrl\":\"https://example.com\",\"secret\":\"8c1da4d8-8684-4a2c-9abb-57b9d5fa7e52\",\"userId\":\"a117460e-41df-4dbd-b2df-4bd0c16efd2f\"}";
-var token = JsonSerializer.Deserialize<OOCv1ApiToken>(json, JsonHelper.camelCaseJsonDeserializerOptions);
+string json = "{\"version\":1,\"baseUrl\":\"https://example.com\",\"secret\":\"8c1da4d8-8684-4a2c-9abb-57b9d5fa7e52\",\"userId\":\"a117460e-41df-4dbd-b2df-4bd0c16efd2f\"}";
+OOCv1ApiToken? token = JsonSerializer.Deserialize(json, OOCv1JsonSerializerContext.Default.OOCv1ApiToken);
 ```
 
 ### 2. Config Base
@@ -34,9 +34,7 @@ var token = JsonSerializer.Deserialize<OOCv1ApiToken>(json, JsonHelper.camelCase
 
 ### 3. API Client
 
-`OOCv1ApiClient` is the general-purpose OOCv1 API client. Use this if you want to handle the response JSON yourself.
-
-`OOCv1ApiClient<T>` is the generic OOCv1 API client. Use this if you have specific protocols in mind. `T` must be a subclass of `OOCv1ConfigBase`.
+`OOCv1ApiClient` is the general-purpose OOCv1 API client. Call `GetAsync<TValue>` to retrieve the online config. `TValue` must be a subclass of `OOCv1ConfigBase`.
 
 ## License
 

src/OpenOnlineConfig/OpenOnlineConfig.Tests/DeserializationTests.cs

@@ -1,4 +1,3 @@
-using OpenOnlineConfig.Utils;
 using OpenOnlineConfig.v1;
 using System.Text.Json;
 using Xunit;
@@ -14,10 +13,10 @@ public class DeserializationTests
             1, "https://github.com", "8b7ef7fd-c2ac-47d9-8517-2b20c4fee5a7", "68720c88-e5e5-4b84-9db7-98fb4be109eb", "0ae384bfd4dde9d13e50c5857c05a442c93f8e01445ee4b34540d22bd1e37f1b")]
         public void ApiToken_Deserialization(string json, int expectedVersion, string expectedBaseUrl, string expectedSecret, string expectedUserId, string? expectedCertSha256)
         {
-            var token = JsonSerializer.Deserialize<OOCv1ApiToken>(json, JsonHelper.camelCaseJsonDeserializerOptions);
+            OOCv1ApiToken? token = JsonSerializer.Deserialize(json, OOCv1JsonSerializerContext.Default.OOCv1ApiToken);
 
             Assert.NotNull(token);
-            Assert.Equal(expectedVersion, token!.Version);
+            Assert.Equal(expectedVersion, token.Version);
             Assert.Equal(expectedBaseUrl, token.BaseUrl);
             Assert.Equal(expectedSecret, token.Secret);
             Assert.Equal(expectedUserId, token.UserId);
@@ -31,10 +30,10 @@ public void ApiToken_Deserialization(string json, int expectedVersion, string ex
             "nobody", 274877906944UL, 824633720832UL, 1609459200L, new string[] { "shadowsocks", "vmess", "trojan-go", })]
         public void ConfigBase_Deserialization(string json, string? expectedUsername, ulong? expectedBytesUsed, ulong? expectedBytesRemaining, long? expectedExpiryDate, string[] expectedProtocols)
         {
-            var config = JsonSerializer.Deserialize<OOCv1ConfigBase>(json, JsonHelper.camelCaseJsonDeserializerOptions);
+            OOCv1ConfigBase? config = JsonSerializer.Deserialize(json, OOCv1JsonSerializerContext.Default.OOCv1ConfigBase);
 
             Assert.NotNull(config);
-            Assert.Equal(expectedUsername, config!.Username);
+            Assert.Equal(expectedUsername, config.Username);
             Assert.Equal(expectedBytesUsed, config.BytesUsed);
             Assert.Equal(expectedBytesRemaining, config.BytesRemaining);
             Assert.Equal(expectedExpiryDate, config.ExpiryDate?.ToUnixTimeSeconds());

src/OpenOnlineConfig/OpenOnlineConfig/OpenOnlineConfig.csproj

@@ -6,15 +6,15 @@
     <Authors>database64128</Authors>
     <Product>OpenOnlineConfig.NET</Product>
     <Description>.NET class library for Open Online Config (OOC) support.</Description>
-    <Copyright>© 2022 database64128</Copyright>
+    <Copyright>© 2025 database64128</Copyright>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageProjectUrl>https://github.com/Shadowsocks-NET/OpenOnlineConfig.NET</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Shadowsocks-NET/OpenOnlineConfig.NET</RepositoryUrl>
     <RepositoryType>Public</RepositoryType>
     <PackageTags>open-online-config;censorship-circumvention</PackageTags>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <NoWarn>CS1591</NoWarn>
-    <Version>1.2.0</Version>
+    <Version>1.3.0</Version>
   </PropertyGroup>
 
   <ItemGroup>

src/OpenOnlineConfig/OpenOnlineConfig/Utils/JsonHelper.cs

@@ -1,8 +1,8 @@
 using System;
 using System.Net.Http;
-using System.Net.Security;
+using System.Net.Http.Json;
 using System.Security.Cryptography;
-using System.Security.Cryptography.X509Certificates;
+using System.Text.Json.Serialization.Metadata;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -13,8 +13,9 @@ namespace OpenOnlineConfig.v1
     /// </summary>
     public class OOCv1ApiClient : IDisposable
     {
-        protected readonly OOCv1ApiToken _apiToken;
         protected readonly HttpClient _httpClient;
+        private readonly Uri _uri;
+        private readonly bool _disposeHttpClient;
         private bool disposedValue;
 
         /// <summary>
@@ -25,7 +26,7 @@ public class OOCv1ApiClient : IDisposable
         /// <param name="httpClient">Supply an existing HttpClient instance.</param>
         public OOCv1ApiClient(OOCv1ApiToken apiToken, HttpClient? httpClient = null)
         {
-            _apiToken = apiToken;
+            _uri = apiToken.UserUrl;
 
             if (apiToken.CertSha256 is null)
             {
@@ -37,14 +38,17 @@ public OOCv1ApiClient(OOCv1ApiToken apiToken, HttpClient? httpClient = null)
                 {
                     SslOptions = new()
                     {
-                        RemoteCertificateValidationCallback = ValidateServerCertificate,
+                        RemoteCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) =>
+                        {
+                            string? sha256Fingerprint = certificate?.GetCertHashString(HashAlgorithmName.SHA256);
+                            return string.Equals(apiToken.CertSha256, sha256Fingerprint, StringComparison.OrdinalIgnoreCase);
+                        },
                     },
                 };
 
                 _httpClient = new(socketsHttpHandler);
+                _disposeHttpClient = true;
             }
-
-            _httpClient.Timeout = TimeSpan.FromSeconds(30.0);
         }
 
         /// <inheritdoc cref="HttpClient.Timeout"/>
@@ -54,15 +58,9 @@ public TimeSpan Timeout
             set => _httpClient.Timeout = value;
         }
 
-        private bool ValidateServerCertificate(object sender, X509Certificate? certificate, X509Chain? chain, SslPolicyErrors sslPolicyErrors)
-        {
-            var sha256Fingerprint = certificate?.GetCertHashString(HashAlgorithmName.SHA256);
-            return string.Equals(_apiToken.CertSha256, sha256Fingerprint, StringComparison.OrdinalIgnoreCase);
-        }
-
         protected virtual void Dispose(bool disposing)
         {
-            if (!disposedValue)
+            if (_disposeHttpClient && !disposedValue)
             {
                 if (disposing)
                 {
@@ -80,11 +78,12 @@ public void Dispose()
         }
 
         /// <summary>
-        /// Retrieves the online config and returns the response JSON as a string in an asynchronous operation.
+        /// Retrieves the online config and deserializes the response JSON as <typeparamref name="TValue"/> in an asynchronous operation.
         /// </summary>
+        /// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
         /// <param name="cancellationToken">The cancellation token to cancel the operation.</param>
-        /// <returns>The task object representing the asynchronous operation.</returns>
-        public Task<string> GetAsync(CancellationToken cancellationToken = default)
-            => _httpClient.GetStringAsync($"{_apiToken.BaseUrl}/{_apiToken.Secret}/ooc/v1/{_apiToken.UserId}", cancellationToken);
+        /// <returns>The <see cref="Task"/> object representing the asynchronous operation.</returns>
+        public Task<TValue?> GetAsync<TValue>(JsonTypeInfo<TValue> jsonTypeInfo, CancellationToken cancellationToken = default) where TValue : OOCv1ConfigBase =>
+            _httpClient.GetFromJsonAsync(_uri, jsonTypeInfo, cancellationToken);
     }
 }

src/OpenOnlineConfig/OpenOnlineConfig/v1/OOCv1ApiClient.cs

@@ -1,8 +1,16 @@
-namespace OpenOnlineConfig.v1
+using System;
+
+namespace OpenOnlineConfig.v1
 {
     /// <summary>
     /// OOCv1 API access information.
     /// Serialize and deserialize in camelCase.
     /// </summary>
-    public record OOCv1ApiToken(int Version, string BaseUrl, string Secret, string UserId, string? CertSha256);
+    public record OOCv1ApiToken(int Version, string BaseUrl, string Secret, string UserId, string? CertSha256)
+    {
+        /// <summary>
+        /// Gets the API URL for the user.
+        /// </summary>
+        public Uri UserUrl => new($"{BaseUrl.TrimEnd('/')}/{Secret}/ooc/v1/{UserId}");
+    }
 }

src/OpenOnlineConfig/OpenOnlineConfig/v1/OOCv1ApiClient{T}.cs

@@ -40,6 +40,6 @@ public class OOCv1ConfigBase
         /// <summary>
         /// Gets or sets the protocols used in the configuration.
         /// </summary>
-        public List<string> Protocols { get; set; } = new();
+        public List<string> Protocols { get; set; } = [];
     }
 }

src/OpenOnlineConfig/OpenOnlineConfig/v1/OOCv1ApiToken.cs

@@ -0,0 +1,13 @@
+using System.Text.Json.Serialization;
+
+namespace OpenOnlineConfig.v1;
+
+[JsonSerializable(typeof(OOCv1ApiToken))]
+[JsonSerializable(typeof(OOCv1ConfigBase))]
+[JsonSourceGenerationOptions(
+    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault,
+    IgnoreReadOnlyProperties = true,
+    PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
+public partial class OOCv1JsonSerializerContext : JsonSerializerContext
+{
+}