Refactor to use better named APIs, tagged services + typed AutoQuery APIs

Author: mythz

src/Northwind.ServiceInterface/CachedServices.cs

@@ -6,13 +6,13 @@ namespace Northwind.ServiceInterface
     [CacheResponse(Duration = 60 * 60, MaxAge = 30 * 60)]
     public class CachedServices : Service
     {
-        public object Get(CachedCustomers request) => 
-            Gateway.Send(new Customers());
+        public object Get(CachedGetAllCustomers request) => 
+            Gateway.Send(new GetAllCustomers());
 
-        public object Get(CachedCustomerDetails request) => 
-            Gateway.Send(new CustomerDetails { Id = request.Id });
+        public object Get(CachedGetCustomerDetails request) => 
+            Gateway.Send(new GetCustomerDetails { Id = request.Id });
 
-        public object Get(CachedOrders request) => 
-            Gateway.Send(new Orders { CustomerId = request.CustomerId, Page = request.Page });
+        public object Get(CachedGetOrders request) => 
+            Gateway.Send(new GetOrders { CustomerId = request.CustomerId, Page = request.Page });
     }
 }

src/Northwind.ServiceInterface/CustomerDetailsService.cs

@@ -9,18 +9,18 @@ namespace Northwind.ServiceInterface
 {
     public class CustomerDetailsService : Service
     {
-        public CustomerDetailsResponse Get(CustomerDetails request)
+        public CustomerDetailsResponse Get(GetCustomerDetails request)
         {
             var customer = Db.SingleById<Customer>(request.Id);
             if (customer == null)
                 throw new HttpError(HttpStatusCode.NotFound,
                     new ArgumentException("Customer does not exist: " + request.Id));
 
-            var ordersResponse = base.Gateway.Send(new Orders { CustomerId = customer.Id });
+            var ordersResponse = base.Gateway.Send(new GetOrders { CustomerId = customer.Id });
             return new CustomerDetailsResponse
             {
                 Customer = customer,
-                CustomerOrders = ordersResponse.Results,
+                Orders = ordersResponse.Results,
             };
         }
     }

src/Northwind.ServiceInterface/CustomersService.cs

@@ -7,7 +7,7 @@ namespace Northwind.ServiceInterface
 {
     public class CustomersService : Service
     {
-        public object Get(Customers request) => 
-            new CustomersResponse { Customers = Db.Select<Customer>() };
+        public object Get(GetAllCustomers request) => 
+            new CustomersResponse { Results = Db.Select<Customer>() };
     }
 }

src/Northwind.ServiceInterface/OrdersService.cs

@@ -10,7 +10,7 @@ public class OrdersService : Service
     {
         private const int PageCount = 20;
 
-        public OrdersResponse Get(Orders request)
+        public OrdersResponse Get(GetOrders request)
         {
             var orders = request.CustomerId.IsNullOrEmpty()
                 ? Db.Select(Db.From<Order>().OrderByDescending(o => o.OrderDate))

src/Northwind.ServiceInterface/VCardFormat.cs

@@ -39,7 +39,7 @@ public static void SerializeToStream(IRequest req, object response, Stream strea
                 var customers = response as CustomersResponse;
                 if (customers != null)
                 {
-                    customers.Customers.ForEach(x => WriteCustomer(sw, x));
+                    customers.Results.ForEach(x => WriteCustomer(sw, x));
                 }
             }
         }

src/Northwind.ServiceModel/AutoQuery.cs

@@ -1,11 +1,19 @@
-using Northwind.ServiceModel.Types;
+using System.Collections.Generic;
+using Northwind.ServiceModel.Types;
 using ServiceStack;
 
 namespace Northwind.ServiceModel
 {
-    [Route("/query/customers")]
-    public class QueryCustomers : QueryDb<Customer> { }
+    [Route("/query/customers"), Tag(Tags.AutoQuery)]
+    public class QueryCustomers : QueryDb<Customer>
+    {
+        public List<string> Ids { get; set; }
+        public string CountryStartsWith { get; set; }
+    }
 
-    [Route("/query/orders")]
-    public class QueryOrders : QueryDb<Order> { }
+    [Route("/query/orders"), Tag(Tags.AutoQuery)]
+    public class QueryOrders : QueryDb<Order>
+    {
+        public decimal? Freight { get; set; }
+    }
 }

src/Northwind.ServiceModel/CachedOperations.cs

@@ -3,30 +3,24 @@
 
 namespace Northwind.ServiceModel
 {
-    [DataContract]
-    [Route("/cached/customers")]
-    public class CachedCustomers
-    {
-    }
+    [Route("/cached/customers"), Tag(Tags.Cached)]
+    public class CachedGetAllCustomers : IReturn<CustomersResponse> {}
 
     [DataContract]
-    [Route("/cached/customers/{Id}")]
-    public class CachedCustomerDetails
+    [Route("/cached/customers/{Id}"), Tag(Tags.Cached)]
+    public class CachedGetCustomerDetails : IReturn<CustomerDetailsResponse>
     {
         [DataMember]
         public string Id { get; set; }
     }
 
-    [DataContract]
+    [Tag(Tags.Cached)]
     [Route("/cached/orders")]
     [Route("/cached/orders/page/{Page}")]
     [Route("/cached/customers/{CustomerId}/orders")]
-    public class CachedOrders
+    public class CachedGetOrders : IReturn<OrdersResponse>
     {
-        [DataMember]
         public int? Page { get; set; }
-
-        [DataMember]
         public string CustomerId { get; set; }
     }
 }

src/Northwind.ServiceModel/Customers.cs …orthwind.ServiceModel/GetAllCustomers.cssrc/Northwind.ServiceModel/Customers.cs renamed to src/Northwind.ServiceModel/GetAllCustomers.cs src/Northwind.ServiceModel/Customers.cs renamed to src/Northwind.ServiceModel/GetAllCustomers.cs

@@ -5,22 +5,14 @@
 
 namespace Northwind.ServiceModel
 {
-    [DataContract]
-    [Route("/customers")]
-    public class Customers : IReturn<CustomersResponse> {}
+    [Route("/customers"), Tag(Tags.Customers)]
+    public class GetAllCustomers : IReturn<CustomersResponse> {}
 
     [DataContract]
     public class CustomersResponse : IHasResponseStatus
     {
-        public CustomersResponse()
-        {
-            this.ResponseStatus = new ResponseStatus();
-            this.Customers = new List<Customer>();
-        }
-
         [DataMember]
-        public List<Customer> Customers { get; set; }
-
+        public List<Customer> Results { get; set; }
         [DataMember]
         public ResponseStatus ResponseStatus { get; set; }
     }

…orthwind.ServiceModel/CustomerDetails.cs …hwind.ServiceModel/GetCustomerDetails.cssrc/Northwind.ServiceModel/CustomerDetails.cs renamed to src/Northwind.ServiceModel/GetCustomerDetails.cs src/Northwind.ServiceModel/CustomerDetails.cs renamed to src/Northwind.ServiceModel/GetCustomerDetails.cs

@@ -5,29 +5,19 @@
 
 namespace Northwind.ServiceModel
 {
-    [DataContract]
-    [Route("/customers/{Id}")]
-    public class CustomerDetails : IReturn<CustomerDetailsResponse>
+    [Route("/customers/{Id}"), Tag(Tags.Customers)]
+    public class GetCustomerDetails : IReturn<CustomerDetailsResponse>
     {
-        [DataMember]
         public string Id { get; set; }
     }
 
     [DataContract]
     public class CustomerDetailsResponse : IHasResponseStatus
     {
-        public CustomerDetailsResponse()
-        {
-            this.ResponseStatus = new ResponseStatus();
-            this.CustomerOrders = new List<CustomerOrder>();
-        }
-
         [DataMember]
         public Customer Customer { get; set; }
-
         [DataMember]
-        public List<CustomerOrder> CustomerOrders { get; set; }
-
+        public List<CustomerOrder> Orders { get; set; }
         [DataMember]
         public ResponseStatus ResponseStatus { get; set; }
     }

src/Northwind.ServiceModel/Orders.cs src/Northwind.ServiceModel/GetOrders.cssrc/Northwind.ServiceModel/Orders.cs renamed to src/Northwind.ServiceModel/GetOrders.cs

@@ -1,29 +1,26 @@
 using ServiceStack;
 using System.Collections.Generic;
+using System.Runtime.Serialization;
 using Northwind.ServiceModel.Types;
 
 namespace Northwind.ServiceModel
 {
+    [Tag(Tags.Orders)]
     [Route("/orders")]
     [Route("/orders/page/{Page}")]
     [Route("/customers/{CustomerId}/orders")]
-    public class Orders : IReturn<OrdersResponse>
+    public class GetOrders : IReturn<OrdersResponse>
     {
         public int? Page { get; set; }
-
         public string CustomerId { get; set; }
     }
 
+    [DataContract]
     public class OrdersResponse : IHasResponseStatus
     {
-        public OrdersResponse()
-        {
-            this.ResponseStatus = new ResponseStatus();
-            this.Results = new List<CustomerOrder>();
-        }
-
+        [DataMember]
         public List<CustomerOrder> Results { get; set; }
-
+        [DataMember]
         public ResponseStatus ResponseStatus { get; set; }
     }
 }