Merge pull request #159 from Research-Institute/develop

v2.1.4 Relative Links

Author: jaredcnance

docs/Options.md

@@ -45,3 +45,39 @@ public IServiceProvider ConfigureServices(IServiceCollection services) {
     // ...
 }
 ```
+
+## Relative Links
+
+All links are absolute by default. However, you can configure relative links:
+
+```csharp
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.RelativeLinks = true);
+    // ...
+}
+```
+
+
+```http
+GET /api/v1/articles/4309 HTTP/1.1
+Accept: application/vnd.api+json
+```
+
+```json
+{
+    "type": "articles",
+    "id": "4309",
+    "attributes": {
+        "name": "Voluptas iure est molestias."
+    },
+    "relationships": {
+        "author": {
+            "links": {
+                "self": "/api/v1/articles/4309/relationships/author",
+                "related": "/api/v1/articles/4309/author"
+            }
+        }
+    }
+}
+```

src/JsonApiDotNetCore/Builders/LinkBuilder.cs

@@ -9,28 +9,30 @@ public class LinkBuilder
 
         public LinkBuilder(IJsonApiContext context)
         {
-            _context = context;   
+            _context = context;
         }
 
         public string GetBasePath(HttpContext context, string entityName)
         {
             var r = context.Request;
-            return $"{r.Scheme}://{r.Host}{GetNamespaceFromPath(r.Path, entityName)}";
+            return (_context.Options.RelativeLinks)
+                ? $"{GetNamespaceFromPath(r.Path, entityName)}"
+                : $"{r.Scheme}://{r.Host}{GetNamespaceFromPath(r.Path, entityName)}";
         }
 
         private string GetNamespaceFromPath(string path, string entityName)
         {
             var nSpace = string.Empty;
             var segments = path.Split('/');
-            
-            for(var i = 1; i < segments.Length; i++)
+
+            for (var i = 1; i < segments.Length; i++)
             {
-                if(segments[i].ToLower() == entityName) 
+                if (segments[i].ToLower() == entityName)
                     break;
 
                 nSpace += $"/{segments[i]}";
             }
-                
+
             return nSpace;
         }
 

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -14,6 +14,7 @@ public class JsonApiOptions
         public bool IncludeTotalRecordCount { get; set; }
         public bool AllowClientGeneratedIds { get; set; }
         public IContextGraph ContextGraph { get; set; }
+        public bool RelativeLinks { get; set; }
         public IContractResolver JsonContractResolver { get; set; } = new DasherizedResolver();
         internal IContextGraphBuilder ContextGraphBuilder { get; } = new ContextGraphBuilder();
 

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <VersionPrefix>2.1.3</VersionPrefix>
+    <VersionPrefix>2.1.4</VersionPrefix>
     <TargetFrameworks>netstandard1.6</TargetFrameworks>
     <AssemblyName>JsonApiDotNetCore</AssemblyName>
     <PackageId>JsonApiDotNetCore</PackageId>

test/UnitTests/Builders/LinkBuilder_Tests.cs

@@ -0,0 +1,48 @@
+using JsonApiDotNetCore.Builders;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Services;
+using Microsoft.AspNetCore.Http;
+using Moq;
+using Xunit;
+
+namespace UnitTests
+{
+    public class LinkBuilder_Tests
+    {
+        [Theory]
+        [InlineData("http", "localhost", "/api/v1/articles", false, "http://localhost/api/v1")]
+        [InlineData("https", "localhost", "/api/v1/articles", false, "https://localhost/api/v1")]
+        [InlineData("http", "example.com", "/api/v1/articles", false, "http://example.com/api/v1")]
+        [InlineData("https", "example.com", "/api/v1/articles", false, "https://example.com/api/v1")]
+        [InlineData("https", "example.com", "/articles", false, "https://example.com")]
+        [InlineData("https", "example.com", "/articles", true, "")]
+        [InlineData("https", "example.com", "/api/v1/articles", true, "/api/v1")]
+        public void GetBasePath_Returns_Path_Before_Resource(string scheme,
+            string host, string path, bool isRelative, string expectedPath)
+        {
+            // arrange
+            const string resource = "articles";
+            var jsonApiContextMock = new Mock<IJsonApiContext>();
+            jsonApiContextMock.Setup(m => m.Options).Returns(new JsonApiOptions
+            {
+                RelativeLinks = isRelative
+            });
+
+            var requestMock = new Mock<HttpRequest>();
+            requestMock.Setup(m => m.Scheme).Returns(scheme);
+            requestMock.Setup(m => m.Host).Returns(new HostString(host));
+            requestMock.Setup(m => m.Path).Returns(new PathString(path));
+
+            var contextMock = new Mock<HttpContext>();
+            contextMock.Setup(m => m.Request).Returns(requestMock.Object);
+
+            var linkBuilder = new LinkBuilder(jsonApiContextMock.Object);
+
+            // act
+            var basePath = linkBuilder.GetBasePath(contextMock.Object, resource);
+
+            // assert
+            Assert.Equal(expectedPath, basePath);
+        }
+    }
+}