Update Web API example with navigation properties

Author: Chris Martinez

samples/webapi/SwaggerODataWebApiSample/Configuration/OrderModelConfiguration.cs

@@ -17,10 +17,12 @@ public class OrderModelConfiguration : IModelConfiguration
         public void Apply( ODataModelBuilder builder, ApiVersion apiVersion )
         {
             var order = builder.EntitySet<Order>( "Orders" ).EntityType.HasKey( o => o.Id );
+            var lineItem = builder.EntityType<LineItem>().HasKey( li => li.Number );
 
             if ( apiVersion < ApiVersions.V2 )
             {
                 order.Ignore( o => o.EffectiveDate );
+                lineItem.Ignore( li => li.Fulfilled );
             }
 
             if ( apiVersion < ApiVersions.V3 )

samples/webapi/SwaggerODataWebApiSample/Configuration/PersonModelConfiguration.cs

@@ -18,6 +18,7 @@ public class PersonModelConfiguration : IModelConfiguration
         public void Apply( ODataModelBuilder builder, ApiVersion apiVersion )
         {
             var person = builder.EntitySet<Person>( "People" ).EntityType;
+            var address = builder.EntityType<Address>().HasKey( a => a.Id );
 
             person.HasKey( p => p.Id );
             person.Select().OrderBy( "firstName", "lastName" );
@@ -34,6 +35,9 @@ public void Apply( ODataModelBuilder builder, ApiVersion apiVersion )
 
             if ( apiVersion > ApiVersions.V1 )
             {
+                person.ContainsOptional( p => p.HomeAddress );
+                person.Ignore( p => p.WorkAddress );
+
                 var function = person.Collection.Function( "NewHires" );
 
                 function.Parameter<DateTime>( "Since" );
@@ -42,6 +46,7 @@ public void Apply( ODataModelBuilder builder, ApiVersion apiVersion )
 
             if ( apiVersion > ApiVersions.V2 )
             {
+                person.ContainsOptional( p => p.WorkAddress );
                 person.Action( "Promote" ).Parameter<string>( "title" );
             }
         }

samples/webapi/SwaggerODataWebApiSample/Models/Address.cs

@@ -0,0 +1,40 @@
+namespace Microsoft.Examples.Models
+{
+    using Microsoft.AspNet.OData.Query;
+    using System;
+
+    /// <summary>
+    /// Represents an address.
+    /// </summary>
+    public class Address
+    {
+        /// <summary>
+        /// Gets or sets the address identifier.
+        /// </summary>
+        public int Id { get; set; }
+
+        /// <summary>
+        /// Gets or sets the street address.
+        /// </summary>
+        /// <value>The street address.</value>
+        public string Street { get; set; }
+
+        /// <summary>
+        /// Gets or sets the address city.
+        /// </summary>
+        /// <value>The address city.</value>
+        public string City { get; set; }
+
+        /// <summary>
+        /// Gets or sets the address state.
+        /// </summary>
+        /// <value>The address state.</value>
+        public string State { get; set; }
+
+        /// <summary>
+        /// Gets or sets the address zip code.
+        /// </summary>
+        /// <value>The address zip code.</value>
+        public string ZipCode { get; set; }
+    }
+}

samples/webapi/SwaggerODataWebApiSample/Models/LineItem.cs

@@ -0,0 +1,42 @@
+namespace Microsoft.Examples.Models
+{
+    using Microsoft.AspNet.OData.Query;
+    using System;
+
+    /// <summary>
+    /// Represents the line item on an order.
+    /// </summary>
+    [Select]
+    public class LineItem
+    {
+        /// <summary>
+        /// Gets or sets the line item number.
+        /// </summary>
+        /// <value>The line item number.</value>
+        public int Number { get; set; }
+
+        /// <summary>
+        /// Gets or sets the line item description.
+        /// </summary>
+        /// <value>The line item description.</value>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the line item quantity.
+        /// </summary>
+        /// <value>The line item quantity.</value>
+        public int Quantity { get; set; }
+
+        /// <summary>
+        /// Gets or sets the line item unit price.
+        /// </summary>
+        /// <value>The line item unit price.</value>
+        public decimal UnitPrice { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the line item is fulfilled.
+        /// </summary>
+        /// <value>True if the line item is fulfilled; otherwise, false.</value>
+        public bool Fulfilled { get; set; }
+    }
+}

samples/webapi/SwaggerODataWebApiSample/Models/Order.cs

@@ -1,7 +1,9 @@
 namespace Microsoft.Examples.Models
 {
+    using Microsoft.AspNet.OData.Builder;
     using Microsoft.AspNet.OData.Query;
     using System;
+    using System.Collections.Generic;
     using System.ComponentModel.DataAnnotations;
 
     /// <summary>
@@ -41,5 +43,12 @@ public class Order
         /// </summary>
         /// <value>The description of the order.</value>
         public string Description { get; set; }
+
+        /// <summary>
+        /// Gets a list of line items in the order.
+        /// </summary>
+        /// <value>The <see cref="IList{T}">list</see> of order <see cref="LineItem">line items</see>.</value>
+        [Contained]
+        public virtual IList<LineItem> LineItems { get; } = new List<LineItem>();
     }
 }

samples/webapi/SwaggerODataWebApiSample/Models/Person.cs

@@ -1,5 +1,6 @@
 namespace Microsoft.Examples.Models
 {
+    using Microsoft.AspNet.OData.Builder;
     using System;
     using System.ComponentModel.DataAnnotations;
 
@@ -41,5 +42,17 @@ public class Person
         /// </summary>
         /// <value>The person's telephone number.</value>
         public string Phone { get; set; }
+
+        /// <summary>
+        /// Gets or sets the person's home address.
+        /// </summary>
+        /// <value>The person's home address.</value>
+        public Address HomeAddress { get; set; }
+
+        /// <summary>
+        /// Gets or sets the person's work address.
+        /// </summary>
+        /// <value>The person's work address.</value>
+        public Address WorkAddress { get; set; }
     }
 }

samples/webapi/SwaggerODataWebApiSample/V1/OrdersController.cs

@@ -4,6 +4,7 @@
     using Microsoft.AspNet.OData.Routing;
     using Microsoft.Examples.Models;
     using Microsoft.Web.Http;
+    using System.Collections.Generic;
     using System.Linq;
     using System.Web.Http;
     using System.Web.Http.Description;
@@ -65,5 +66,28 @@ public IHttpActionResult Post( [FromBody] Order order )
         [ResponseType( typeof( Order ) )]
         [EnableQuery( AllowedQueryOptions = Select )]
         public SingleResult<Order> MostExpensive() => SingleResult.Create( new[] { new Order() { Id = 42, Customer = "Bill Mei" } }.AsQueryable() );
+
+        /// <summary>
+        /// Gets the line items for the specified order.
+        /// </summary>
+        /// <param name="key">The order identifier.</param>
+        /// <returns>The order line items.</returns>
+        /// <response code="200">The line items were successfully retrieved.</response>
+        /// <response code="404">The order does not exist.</response>
+        [HttpGet]
+        [ODataRoute( "({key})/LineItems" )]
+        [ResponseType( typeof( ODataValue<IEnumerable<LineItem>> ) )]
+        [EnableQuery( AllowedQueryOptions = Select )]
+        public IHttpActionResult LineItems( int key )
+        {
+            var lineItems = new[]
+            {
+                new LineItem() { Number = 1, Quantity = 1, UnitPrice = 2m, Description = "Dry erase wipes" },
+                new LineItem() { Number = 2, Quantity = 1, UnitPrice = 3.5m, Description = "Dry erase eraser" },
+                new LineItem() { Number = 3, Quantity = 1, UnitPrice = 5m, Description = "Dry erase markers" },
+            };
+
+            return Ok( lineItems );
+        }
     }
 }

samples/webapi/SwaggerODataWebApiSample/V2/OrdersController.cs

@@ -131,5 +131,28 @@ public IHttpActionResult Rate( int key, ODataActionParameters parameters )
             var rating = (int) parameters["rating"];
             return StatusCode( NoContent );
         }
+
+        /// <summary>
+        /// Gets the line items for the specified order.
+        /// </summary>
+        /// <param name="key">The order identifier.</param>
+        /// <returns>The order line items.</returns>
+        /// <response code="200">The line items were successfully retrieved.</response>
+        /// <response code="404">The order does not exist.</response>
+        [HttpGet]
+        [ODataRoute( "({key})/LineItems" )]
+        [ResponseType( typeof( ODataValue<IEnumerable<LineItem>> ) )]
+        [EnableQuery( AllowedQueryOptions = Select )]
+        public IHttpActionResult LineItems( int key )
+        {
+            var lineItems = new[]
+            {
+                new LineItem() { Number = 1, Quantity = 1, UnitPrice = 2m, Description = "Dry erase wipes" },
+                new LineItem() { Number = 2, Quantity = 1, UnitPrice = 3.5m, Description = "Dry erase eraser" },
+                new LineItem() { Number = 3, Quantity = 1, UnitPrice = 5m, Description = "Dry erase markers" },
+            };
+
+            return Ok( lineItems );
+        }
     }
 }

samples/webapi/SwaggerODataWebApiSample/V2/PeopleController.cs

@@ -112,5 +112,24 @@ public IHttpActionResult Get( int key, ODataQueryOptions<Person> options )
         [HttpGet]
         [ResponseType( typeof( ODataValue<IEnumerable<Person>> ) )]
         public IHttpActionResult NewHires( DateTime since, ODataQueryOptions<Person> options ) => Get( options );
+
+        /// <summary>
+        /// Gets the home address of a person.
+        /// </summary>
+        /// <param name="key">The person identifier.</param>
+        /// <returns>The person's home address.</returns>
+        /// <response code="200">The home address was successfully retrieved.</response>
+        /// <response code="404">The person does not exist.</response>
+        [HttpGet]
+        [ResponseType( typeof( Address ) )]
+        public IHttpActionResult GetHomeAddress( int key ) =>
+            Ok( new Address()
+            {
+                Id = 42,
+                Street = "123 Some Place",
+                City = "Seattle",
+                State = "WA",
+                ZipCode = "98101"
+            } );
     }
 }

samples/webapi/SwaggerODataWebApiSample/V3/OrdersController.cs

@@ -143,5 +143,28 @@ public IHttpActionResult Rate( int key, ODataActionParameters parameters )
             var rating = (int) parameters["rating"];
             return StatusCode( NoContent );
         }
+
+        /// <summary>
+        /// Gets the line items for the specified order.
+        /// </summary>
+        /// <param name="key">The order identifier.</param>
+        /// <returns>The order line items.</returns>
+        /// <response code="200">The line items were successfully retrieved.</response>
+        /// <response code="404">The order does not exist.</response>
+        [HttpGet]
+        [ODataRoute( "({key})/LineItems" )]
+        [ResponseType( typeof( ODataValue<IEnumerable<LineItem>> ) )]
+        [EnableQuery( AllowedQueryOptions = Select )]
+        public IHttpActionResult LineItems( int key )
+        {
+            var lineItems = new[]
+            {
+                new LineItem() { Number = 1, Quantity = 1, UnitPrice = 2m, Description = "Dry erase wipes" },
+                new LineItem() { Number = 2, Quantity = 1, UnitPrice = 3.5m, Description = "Dry erase eraser" },
+                new LineItem() { Number = 3, Quantity = 1, UnitPrice = 5m, Description = "Dry erase markers" },
+            };
+
+            return Ok( lineItems );
+        }
     }
 }