Update examples to show extracting a related key from a URI

Author: commonsensesoftware

examples/AspNet/OData/OpenApiODataWebApiExample/ODataExtensions.cs

@@ -0,0 +1,29 @@
+namespace ApiVersioning.Examples;
+
+using Microsoft.AspNet.OData.Extensions;
+using Microsoft.OData.UriParser;
+using System.Web.Http;
+
+internal static class ODataExtensions
+{
+    public static IReadOnlyDictionary<string, object> GetRelatedKeys( this ApiController controller, Uri uri )
+    {
+        var request = controller.Request;
+        var pathHandler = request.GetPathHandler();
+        var serviceRoot = controller.Url.CreateODataLink();
+        var path = pathHandler.Parse( serviceRoot, uri.AbsoluteUri, request.GetRequestContainer() );
+        var keys = new Dictionary<string, object>( StringComparer.OrdinalIgnoreCase );
+
+        if ( path.Segments.OfType<KeySegment>().FirstOrDefault<KeySegment>() is KeySegment segment )
+        {
+            foreach ( var pair in segment.Keys )
+            {
+                keys.Add( pair.Key, pair.Value );
+            }
+        }
+
+        return keys;
+    }
+
+    public static object GetRelatedKey( this ApiController controller, Uri uri ) => controller.GetRelatedKeys( uri ).Values.SingleOrDefault();
+}

examples/AspNet/OData/OpenApiODataWebApiExample/V3/AcmeController.cs

@@ -37,7 +37,11 @@ public class AcmeController : ODataController
     /// <param name="link">The product identifier.</param>
     /// <returns>None</returns>
     [HttpPost]
-    public IHttpActionResult CreateRef( string navigationProperty, [FromBody] Uri link ) => StatusCode( NoContent );
+    public IHttpActionResult CreateRef( string navigationProperty, [FromBody] Uri link )
+    {
+        var relatedKey = this.GetRelatedKey( link );
+        return StatusCode( NoContent );
+    }
 
     /// <summary>
     /// Unlinks a product from a supplier.

examples/AspNet/OData/OpenApiODataWebApiExample/V3/ProductsController.cs

@@ -189,7 +189,11 @@ public IHttpActionResult GetRefToSupplier( [FromODataUri] int key, string naviga
     public IHttpActionResult CreateRefToSupplier(
         [FromODataUri] int key,
         string navigationProperty,
-        [FromBody] Uri link ) => StatusCode( NoContent );
+        [FromBody] Uri link )
+    {
+        var relatedKey = this.GetRelatedKey( link );
+        return StatusCode( NoContent );
+    }
 
     /// <summary>
     /// Unlinks a supplier from a product.

examples/AspNet/OData/OpenApiODataWebApiExample/V3/SuppliersController.cs

@@ -133,7 +133,11 @@ public IQueryable<Product> GetProducts( [FromODataUri] int key ) =>
     public IHttpActionResult CreateRefToProducts(
         [FromODataUri] int key,
         string navigationProperty,
-        [FromBody] Uri link ) => StatusCode( NoContent );
+        [FromBody] Uri link )
+    {
+        var relatedKey = this.GetRelatedKey( link );
+        return StatusCode( NoContent );
+    }
 
     /// <summary>
     /// Unlinks a product from a supplier.

examples/AspNetCore/OData/ODataOpenApiExample/ODataExtensions.cs

@@ -0,0 +1,34 @@
+namespace ApiVersioning.Examples;
+
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.OData.Extensions;
+using Microsoft.OData;
+using Microsoft.OData.UriParser;
+
+internal static class ODataExtensions
+{
+    public static IReadOnlyDictionary<string, object> GetRelatedKeys( this ControllerBase controller, Uri uri )
+    {
+        // REF: https://github.com/OData/AspNetCoreOData/blob/main/src/Microsoft.AspNetCore.OData/Routing/Parser/DefaultODataPathParser.cs
+        var feature = controller.HttpContext.ODataFeature();
+        var model = feature.Model;
+        var serviceRoot = new Uri( new Uri( feature.BaseAddress ), feature.RoutePrefix );
+        var requestProvider = feature.Services;
+        var parser = new ODataUriParser( model, serviceRoot, uri, requestProvider );
+
+        parser.Resolver ??= new UnqualifiedODataUriResolver() { EnableCaseInsensitive = true };
+        parser.UrlKeyDelimiter = ODataUrlKeyDelimiter.Slash;
+
+        var path = parser.ParsePath();
+        var segment = path.OfType<KeySegment>().FirstOrDefault<KeySegment>();
+
+        if ( segment is null )
+        {
+            return new Dictionary<string, object>( capacity: 0 );
+        }
+
+        return new Dictionary<string, object>( segment.Keys, StringComparer.OrdinalIgnoreCase );
+    }
+
+    public static object GetRelatedKey( this ControllerBase controller, Uri uri ) => controller.GetRelatedKeys( uri ).Values.SingleOrDefault();
+}

examples/AspNetCore/OData/ODataOpenApiExample/V3/AcmeController.cs

@@ -44,7 +44,11 @@ public class AcmeController : ODataController
     [ProducesResponseType( Status404NotFound )]
     public IActionResult CreateRef(
         string navigationProperty,
-        [FromBody] Uri link ) => NoContent();
+        [FromBody] Uri link )
+    {
+        var relatedKey = this.GetRelatedKey( link );
+        return NoContent();
+    }
 
     /// <summary>
     /// Unlinks a product from a supplier.

examples/AspNetCore/OData/ODataOpenApiExample/V3/ProductsController.cs

@@ -20,8 +20,8 @@ public class ProductsController : ODataController
 {
     private readonly IQueryable<Product> products = new[]
     {
-        NewProduct( 1 ), 
-        NewProduct( 2 ), 
+        NewProduct( 1 ),
+        NewProduct( 2 ),
         NewProduct( 3 ),
     }.AsQueryable();
 
@@ -191,9 +191,13 @@ public IActionResult GetRef( int key, string navigationProperty )
     [ProducesResponseType( Status204NoContent )]
     [ProducesResponseType( Status404NotFound )]
     public IActionResult CreateRef(
-        int key, 
-        string navigationProperty, 
-        [FromBody] Uri link ) => NoContent();
+        int key,
+        string navigationProperty,
+        [FromBody] Uri link )
+    {
+        var relatedKey = this.GetRelatedKey( link );
+        return NoContent();
+    }
 
     /// <summary>
     /// Unlinks a supplier from a product.
@@ -206,7 +210,7 @@ public IActionResult CreateRef(
     [ProducesResponseType( Status204NoContent )]
     [ProducesResponseType( Status404NotFound )]
     public IActionResult DeleteRef(
-        int key, 
+        int key,
         string navigationProperty,
         int relatedKey ) => NoContent();
 

examples/AspNetCore/OData/ODataOpenApiExample/V3/SuppliersController.cs

@@ -162,9 +162,13 @@ public IQueryable<Product> GetProducts( int key ) =>
     [ProducesResponseType( Status204NoContent )]
     [ProducesResponseType( Status404NotFound )]
     public IActionResult CreateRef(
-        int key, 
-        string navigationProperty, 
-        [FromBody] Uri link ) => NoContent();
+        int key,
+        string navigationProperty,
+        [FromBody] Uri link )
+    {
+        var relatedKey = this.GetRelatedKey( link );
+        return NoContent();
+    }
 
     /// <summary>
     /// Unlinks a product from a supplier.