Fix issue with custom routing. Closes #29.

rbeauchamp · Dec 27, 2015 · f854b82 · f854b82
1 parent 26fc61f
commit f854b82
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 8 deletions.
diff --git a/Swashbuckle.OData.Nuget/Swashbuckle.OData.NuGet.nuproj b/Swashbuckle.OData.Nuget/Swashbuckle.OData.NuGet.nuproj
@@ -25,12 +25,12 @@
  <Owners>Richard Beauchamp</Owners>
  <Summary>Extends Swashbuckle with OData v4 support!</Summary>
  <Description>Extends Swashbuckle with OData v4 support!</Description>
- <ReleaseNotes>Limits the swagger model-schema to the top-level entity</ReleaseNotes>
+ <ReleaseNotes>Fix issue with custom routes</ReleaseNotes>
  <ProjectUrl>https://github.com/rbeauchamp/Swashbuckle.OData</ProjectUrl>
  <LicenseUrl>https://github.com/rbeauchamp/Swashbuckle.OData/blob/master/License.txt</LicenseUrl>
  <Copyright>Copyright 2015</Copyright>
  <Tags>Swashbuckle Swagger SwaggerUi OData Documentation Discovery Help WebApi AspNet AspNetWebApi Docs WebHost IIS</Tags>
- <Version>2.8.0</Version>
+ <Version>2.8.1</Version>
  </PropertyGroup>
  <ItemGroup>
  <ProjectReference Include="..\Swashbuckle.OData\Swashbuckle.OData.csproj" />

diff --git a/Swashbuckle.OData.Sample/App_Start/CustomNavigationPropertyRoutingConvention.cs b/Swashbuckle.OData.Sample/App_Start/CustomNavigationPropertyRoutingConvention.cs
@@ -13,10 +13,15 @@ public override string SelectAction(ODataPath odataPath, HttpControllerContext c
  {
  var controllerType = controllerContext.Controller.GetType();
 
- if (typeof (CustomersController) == controllerType)
+ if (typeof(CustomersController) == controllerType)
  {
+ if (odataPath.PathTemplate.Equals("~/entityset/key/navigation")) //POST OR GET
+ {
+ controllerContext.RouteData.Values["orderID"] = (odataPath.Segments[1] as KeyValuePathSegment).Value;
+ return controllerContext.Request.Method.ToString();
+ }
  }
- else if (typeof (OrdersController) == controllerType)
+ else if (typeof(OrdersController) == controllerType)
  {
  if (odataPath.PathTemplate.Equals("~/entityset/key/navigation")) //POST OR GET
  {
@@ -41,8 +46,8 @@ public override string SelectController(ODataPath odataPath, HttpRequestMessage
  if (odataPath.PathTemplate.Contains("~/entityset/key/navigation"))
  {
  // Find controller. Controller should be last navigation property
- return ODataSegmentKinds.Navigation == odataPath.Segments[odataPath.Segments.Count - 1].SegmentKind 
- ? odataPath.Segments[odataPath.Segments.Count - 1].ToString() 
+ return ODataSegmentKinds.Navigation == odataPath.Segments[odataPath.Segments.Count - 1].SegmentKind
+ ? odataPath.Segments[odataPath.Segments.Count - 1].ToString()
  : odataPath.Segments[odataPath.Segments.Count - 2].ToString();
  }
  return base.SelectController(odataPath, request);

diff --git a/Swashbuckle.OData.Sample/ODataControllers/OrdersController.cs b/Swashbuckle.OData.Sample/ODataControllers/OrdersController.cs
@@ -47,6 +47,11 @@ public async Task<IHttpActionResult> Post([FromODataUri] int customerId, Order o
  return Created(order);
  }
 
+ public async Task<IHttpActionResult> Delete([FromODataUri] int customerId, [FromODataUri] Guid orderID)
+ {
+ throw new NotImplementedException();
+ }
+
  /// <summary>
  /// Query the order by id
  /// </summary>

diff --git a/Swashbuckle.OData.Tests/Fixtures/CustomRouteTests.cs b/Swashbuckle.OData.Tests/Fixtures/CustomRouteTests.cs
@@ -41,6 +41,27 @@ public async Task It_allows_definition_of_custom_routes()
  }
  }
 
+ [Test]
+ public async Task It_allows_definition_of_custom_delete_routes()
+ {
+ using (WebApp.Start(HttpClientUtils.BaseAddress, builder => Configuration(builder, typeof(OrdersController))))
+ {
+ // Arrange
+ var httpClient = HttpClientUtils.GetHttpClient(HttpClientUtils.BaseAddress);
+
+ // Act
+ var swaggerDocument = await httpClient.GetJsonAsync<SwaggerDocument>("swagger/docs/v1");
+
+ // Assert
+ PathItem pathItem;
+ swaggerDocument.paths.TryGetValue("/odata/Customers({Id})/Orders({orderID})", out pathItem);
+ pathItem.Should().NotBeNull();
+ pathItem.delete.Should().NotBeNull();
+
+ await ValidationUtils.ValidateSwaggerJson();
+ }
+ }
+
  private static void Configuration(IAppBuilder appBuilder, Type targetController)
  {
  var config = appBuilder.GetStandardHttpConfig(targetController);
@@ -54,6 +75,11 @@ private static void Configuration(IAppBuilder appBuilder, Type targetController)
  .PathParameter<int>("Id")
  .BodyParameter<Order>("order");
 
+ config.AddCustomSwaggerRoute(customODataRoute, "/Customers({Id})/Orders({orderID})")
+ .Operation(HttpMethod.Delete)
+ .PathParameter<int>("Id")
+ .PathParameter<Guid>("orderID");
+
  config.EnsureInitialized();
  }
 

diff --git a/Swashbuckle.OData/Descriptions/ODataSwaggerUtilities.cs b/Swashbuckle.OData/Descriptions/ODataSwaggerUtilities.cs
@@ -685,7 +685,8 @@ internal static IList<Parameter> Parameter(this IList<Parameter> parameters, str
  {
  name = name,
  @in = kind,
- description = description
+ description = description,
+ required = true
  };
 
  if (kind != "body")

diff --git a/Swashbuckle.OData/Properties/AssemblyInfo.cs b/Swashbuckle.OData/Properties/AssemblyInfo.cs
@@ -37,4 +37,4 @@
 
 [assembly: AssemblyVersion("1.0.0.0")]
 [assembly: AssemblyFileVersion("1.0.0.0")]
-[assembly: AssemblyInformationalVersion("2.8.0")]
+[assembly: AssemblyInformationalVersion("2.8.1")]