BREAKING: Break Newtonsoft.Json dependency, project clean-up

.github/workflows/dotnet.yml

@@ -16,10 +16,14 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: Setup .NET
+    - name: Setup .NET 8
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.0.x
+    - name: Setup .NET 6
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 6.0.x
     - name: Restore dependencies
       run: dotnet restore
     - name: Build

F23.Hateoas.NewtonsoftJson/F23.Hateoas.NewtonsoftJson.csproj

@@ -0,0 +1,40 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <PackageId>F23.Hateoas.NewtonsoftJson</PackageId>
+        <Version>2.0.0</Version>
+        <TargetFrameworks>net8.0;netstandard2.0</TargetFrameworks>
+        <Authors>feature[23]</Authors>
+        <Description>Newtonsoft.Json support for F23.Hateoas.</Description>
+        <Copyright>2025, feature[23]</Copyright>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+        <PackageProjectUrl>https://github.com/feature23/hateoas</PackageProjectUrl>
+        <RepositoryUrl>https://github.com/feature23/hateoas.git</RepositoryUrl>
+        <RepositoryType>git</RepositoryType>
+        <PackageTags>hateoas hypermedia asp.net core mvc api newtonsoft json</PackageTags>
+        <PackageIcon>logo.png</PackageIcon>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+        <IncludeSymbols>true</IncludeSymbols>
+        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+        <Nullable>enable</Nullable>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+        <LangVersion>latest</LangVersion>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\F23.Hateoas\F23.Hateoas.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <None Include="../F23.Hateoas/logo.png" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
+    </ItemGroup>
+
+</Project>

F23.Hateoas.NewtonsoftJson/HypermediaLinkJsonConverter.cs

@@ -0,0 +1,50 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace F23.Hateoas.NewtonsoftJson;
+
+public class HypermediaLinkJsonConverter : JsonConverter
+{
+    public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
+    {
+        if (value is not HypermediaLink link)
+        {
+            writer.WriteNull();
+            return;
+        }
+
+        writer.WriteStartObject();
+
+        writer.WritePropertyName("rel");
+        serializer.Serialize(writer, link.Rel);
+
+        writer.WritePropertyName("href");
+        serializer.Serialize(writer, link.Href);
+
+        if (link.Method != null)
+        {
+            writer.WritePropertyName("method");
+            serializer.Serialize(writer, link.Method);
+        }
+
+        writer.WriteEndObject();
+    }
+
+    public override object ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer)
+    {
+        var jsonObject = JObject.Load(reader);
+
+        var rel = jsonObject["rel"]
+            ?? throw new JsonSerializationException("Missing required property 'rel'.");
+
+        var href = jsonObject["href"]
+            ?? throw new JsonSerializationException("Missing required property 'href'.");
+
+        var method = jsonObject["method"];
+
+        return new HypermediaLink(rel.Value<string>()!, href.Value<string>()!, method?.Value<string>());
+    }
+
+    public override bool CanConvert(Type objectType)
+        => objectType == typeof(HypermediaLink);
+}

F23.Hateoas.NewtonsoftJson/HypermediaResponseJsonConverter.cs

@@ -0,0 +1,61 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace F23.Hateoas.NewtonsoftJson;
+
+public class HypermediaResponseJsonConverter : JsonConverter
+{
+    public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
+    {
+        if (value is not HypermediaResponse response)
+        {
+            writer.WriteNull();
+            return;
+        }
+
+        writer.WriteStartObject();
+
+        writer.WritePropertyName("content");
+        serializer.Serialize(writer, response.Content);
+
+        if (response.Links != null)
+        {
+            writer.WritePropertyName("_links");
+            writer.WriteStartArray();
+
+            foreach (var link in response.Links)
+            {
+                serializer.Serialize(writer, link);
+            }
+
+            writer.WriteEndArray();
+        }
+
+        writer.WriteEndObject();
+    }
+
+    public override object ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer)
+    {
+        var jsonObject = JObject.Load(reader);
+
+        var content = jsonObject["content"]
+            ?? throw new JsonSerializationException("Missing required property 'content'.");
+
+        var response = new HypermediaResponse(content);
+
+        var links = jsonObject["_links"];
+
+        if (links != null)
+        {
+            foreach (var link in links)
+            {
+                response.Add(serializer.Deserialize<HypermediaLink>(link.CreateReader())!);
+            }
+        }
+
+        return response;
+    }
+
+    public override bool CanConvert(Type objectType)
+        => objectType == typeof(HypermediaResponse);
+}

F23.Hateoas.NewtonsoftJson/README.md

@@ -0,0 +1,40 @@
+# F23.Hateoas.NewtonsoftJson
+
+This library provides compatibility between [F23.Hateoas](https://github.com/feature23/hateoas) 
+and [Newtonsoft.Json](https://www.newtonsoft.com/json).
+
+## Installation
+
+You can install this library via NuGet:
+
+```bash
+dotnet add package F23.Hateoas.NewtonsoftJson
+```
+
+## Usage
+
+Add the `HypermediaResponseJsonConverter` and `HypermediaLinkJsonConverter` to the `JsonSerializerSettings`:
+
+```csharp
+using F23.Hateoas.NewtonsoftJson;
+
+var options = new JsonSerializerSettings
+{
+    Converters =
+    {
+        new HypermediaResponseJsonConverter(),
+        new HypermediaLinkJsonConverter(),
+    }
+};
+```
+
+This can be done during ASP.NET Core startup:
+
+```csharp
+builder.Services.AddControllers()
+    .AddNewtonsoftJson(options =>
+    {
+        options.SerializerSettings.Converters.Add(new HypermediaResponseJsonConverter());
+        options.SerializerSettings.Converters.Add(new HypermediaLinkJsonConverter());
+    });
+```

F23.Hateoas.NewtonsoftJson/RequiredPropertiesBackCompat.cs

@@ -0,0 +1,41 @@
+using System.ComponentModel;
+
+namespace System.Runtime.CompilerServices
+{
+#if !NET5_0_OR_GREATER
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    internal static class IsExternalInit {}
+
+#endif // !NET5_0_OR_GREATER
+
+#if !NET7_0_OR_GREATER
+
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
+    internal sealed class RequiredMemberAttribute : Attribute {}
+
+    [AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)]
+    internal sealed class CompilerFeatureRequiredAttribute : Attribute
+    {
+        public CompilerFeatureRequiredAttribute(string featureName)
+        {
+            FeatureName = featureName;
+        }
+
+        public string FeatureName { get; }
+        public bool   IsOptional  { get; init; }
+
+        public const string RefStructs      = nameof(RefStructs);
+        public const string RequiredMembers = nameof(RequiredMembers);
+    }
+
+#endif // !NET7_0_OR_GREATER
+}
+
+namespace System.Diagnostics.CodeAnalysis
+{
+#if !NET7_0_OR_GREATER
+    [AttributeUsage(AttributeTargets.Constructor, AllowMultiple = false, Inherited = false)]
+    internal sealed class SetsRequiredMembersAttribute : Attribute {}
+#endif
+}

F23.Hateoas.Sample.NewtonsoftJson/F23.Hateoas.Sample.NewtonsoftJson.csproj

@@ -13,7 +13,8 @@
     </ItemGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\F23.Hateoas\F23.Hateoas.csproj" />
+        <ProjectReference Include="..\F23.Hateoas\F23.Hateoas.csproj" />
+        <ProjectReference Include="..\F23.Hateoas.NewtonsoftJson\F23.Hateoas.NewtonsoftJson.csproj" />
     </ItemGroup>
 
 </Project>

F23.Hateoas.Sample.NewtonsoftJson/Program.cs

@@ -1,4 +1,5 @@
 using F23.Hateoas;
+using F23.Hateoas.NewtonsoftJson;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -8,7 +9,11 @@
 builder.Services.AddSwaggerGen();
 
 builder.Services.AddControllers()
-    .AddNewtonsoftJson();
+    .AddNewtonsoftJson(options =>
+    {
+        options.SerializerSettings.Converters.Add(new HypermediaResponseJsonConverter());
+        options.SerializerSettings.Converters.Add(new HypermediaLinkJsonConverter());
+    });
 
 var app = builder.Build();
 

F23.Hateoas.Sample.NewtonsoftJson/Properties/launchSettings.json

@@ -1,13 +1,5 @@
 {
   "$schema": "http://json.schemastore.org/launchsettings.json",
-  "iisSettings": {
-    "windowsAuthentication": false,
-    "anonymousAuthentication": true,
-    "iisExpress": {
-      "applicationUrl": "http://localhost:10201",
-      "sslPort": 44369
-    }
-  },
   "profiles": {
     "http": {
       "commandName": "Project",
@@ -28,14 +20,6 @@
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
-    },
-    "IIS Express": {
-      "commandName": "IISExpress",
-      "launchBrowser": true,
-      "launchUrl": "swagger",
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      }
     }
   }
 }

F23.Hateoas.Sample.SystemTextJson/AppBaseController.cs

@@ -0,0 +1,11 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace F23.Hateoas.Sample.SystemTextJson;
+
+public abstract class AppBaseController : ControllerBase
+{
+    protected IActionResult HypermediaOk(object content, IList<HypermediaLink>? links = null)
+    {
+        return Ok(new HypermediaResponse(content) { Links = links });
+    }
+}

F23.Hateoas.Sample.SystemTextJson/ExampleController.cs

@@ -0,0 +1,20 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace F23.Hateoas.Sample.SystemTextJson;
+
+public class ExampleController : AppBaseController
+{
+    [HttpGet("api/example")]
+    public IActionResult GetExample()
+    {
+        var data = new
+        {
+            Message = "Hello World!",
+        };
+
+        return HypermediaOk(data, [
+            new HypermediaLink("self", "/api/example"),
+            new HypermediaLink("google", "https://www.google.com"),
+        ]);
+    }
+}

F23.Hateoas.Sample.SystemTextJson/F23.Hateoas.Sample.SystemTextJson.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+    <PropertyGroup>
+        <TargetFramework>net8.0</TargetFramework>
+        <Nullable>enable</Nullable>
+        <ImplicitUsings>enable</ImplicitUsings>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.14" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="7.3.1" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\F23.Hateoas\F23.Hateoas.csproj" />
+    </ItemGroup>
+
+</Project>

F23.Hateoas.Sample.SystemTextJson/Program.cs

@@ -0,0 +1,23 @@
+var builder = WebApplication.CreateBuilder(args);
+
+// Add services to the container.
+// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
+builder.Services.AddEndpointsApiExplorer();
+builder.Services.AddSwaggerGen();
+
+builder.Services.AddControllers(); // uses System.Text.Json by default
+
+var app = builder.Build();
+
+// Configure the HTTP request pipeline.
+if (app.Environment.IsDevelopment())
+{
+    app.UseSwagger();
+    app.UseSwaggerUI();
+}
+
+app.UseHttpsRedirection();
+
+app.MapControllers();
+
+app.Run();