Merge pull request #1582 from json-api-dotnet/fix-absolute-location-header

Fixed: send absolute/relative URL in location header, depending on options.UseRelativeLinks

Author: bkoelman

src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs

@@ -3,6 +3,8 @@
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Services;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Extensions;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 
@@ -207,7 +209,7 @@ public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource
         TResource? newResource = await _create.CreateAsync(resource, cancellationToken);
 
         string resourceId = (newResource ?? resource).StringId!;
-        string locationUrl = HttpContext.Request.Path.Add($"/{resourceId}");
+        string locationUrl = GetLocationUrl(resourceId);
 
         if (newResource == null)
         {
@@ -218,6 +220,15 @@ public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource
         return Created(locationUrl, newResource);
     }
 
+    private string GetLocationUrl(string resourceId)
+    {
+        PathString locationPath = HttpContext.Request.Path.Add($"/{resourceId}");
+
+        return _options.UseRelativeLinks
+            ? UriHelper.BuildRelative(HttpContext.Request.PathBase, locationPath)
+            : UriHelper.BuildAbsolute(HttpContext.Request.Scheme, HttpContext.Request.Host, HttpContext.Request.PathBase, locationPath);
+    }
+
     /// <summary>
     /// Adds resources to a to-many relationship. Example: <code><![CDATA[
     /// POST /articles/1/revisions HTTP/1.1

test/JsonApiDotNetCoreTests/IntegrationTests/Links/AbsoluteLinksWithNamespaceTests.cs

@@ -394,6 +394,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
                 value.Links.Related.Should().Be($"{photoLink}/album");
             });
         });
+
+        httpResponse.Headers.Location.Should().Be(albumLink);
     }
 
     [Fact]

test/JsonApiDotNetCoreTests/IntegrationTests/Links/AbsoluteLinksWithoutNamespaceTests.cs

@@ -394,6 +394,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
                 value.Links.Related.Should().Be($"{photoLink}/album");
             });
         });
+
+        httpResponse.Headers.Location.Should().Be(albumLink);
     }
 
     [Fact]

test/JsonApiDotNetCoreTests/IntegrationTests/Links/RelativeLinksWithNamespaceTests.cs

@@ -394,6 +394,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
                 value.Links.Related.Should().Be($"{photoLink}/album");
             });
         });
+
+        httpResponse.Headers.Location.Should().Be(albumLink);
     }
 
     [Fact]

test/JsonApiDotNetCoreTests/IntegrationTests/Links/RelativeLinksWithoutNamespaceTests.cs

@@ -394,6 +394,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
                 value.Links.Related.Should().Be($"{photoLink}/album");
             });
         });
+
+        httpResponse.Headers.Location.Should().Be(albumLink);
     }
 
     [Fact]

test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/Creating/CreateResourceTests.cs

@@ -58,15 +58,15 @@ public async Task Sets_location_header_for_created_resource()
         httpResponse.ShouldHaveStatusCode(HttpStatusCode.Created);
 
         string newWorkItemId = responseDocument.Data.SingleValue.ShouldNotBeNull().Id.ShouldNotBeNull();
-        httpResponse.Headers.Location.Should().Be($"/workItems/{newWorkItemId}");
+        httpResponse.Headers.Location.Should().Be($"http://localhost/workItems/{newWorkItemId}");
 
         responseDocument.Links.ShouldNotBeNull();
         responseDocument.Links.Self.Should().Be("http://localhost/workItems/");
         responseDocument.Links.First.Should().BeNull();
 
         responseDocument.Data.SingleValue.ShouldNotBeNull();
         responseDocument.Data.SingleValue.Links.ShouldNotBeNull();
-        responseDocument.Data.SingleValue.Links.Self.Should().Be($"http://localhost{httpResponse.Headers.Location}");
+        responseDocument.Data.SingleValue.Links.Self.Should().Be($"{httpResponse.Headers.Location}");
     }
 
     [Fact]