Add API Explorer support for OData query options for non-OData endpoints

Author: commonsensesoftware

src/AspNet/OData/src/Asp.Versioning.WebApi.OData.ApiExplorer/ApiExplorer/ODataApiExplorer.cs

@@ -7,6 +7,7 @@ namespace Asp.Versioning.ApiExplorer;
 using Asp.Versioning.OData;
 using Asp.Versioning.Routing;
 using Microsoft.AspNet.OData;
+using Microsoft.AspNet.OData.Extensions;
 using Microsoft.AspNet.OData.Formatter;
 using Microsoft.AspNet.OData.Routing;
 using Microsoft.AspNet.OData.Routing.Template;
@@ -63,15 +64,12 @@ public ODataApiExplorer( HttpConfiguration configuration, ODataApiExplorerOption
     protected virtual IModelTypeBuilder ModelTypeBuilder =>
         modelTypeBuilder ??= Configuration.DependencyResolver.GetModelTypeBuilder();
 
-    /// <summary>
-    /// Determines whether the action should be considered.
-    /// </summary>
-    /// <param name="actionRouteParameterValue">The action route parameter value.</param>
-    /// <param name="actionDescriptor">The associated <see cref="HttpActionDescriptor">action descriptor</see>.</param>
-    /// <param name="route">The associated <see cref="IHttpRoute">route</see>.</param>
-    /// <param name="apiVersion">The <see cref="ApiVersion">API version</see> to consider the controller for.</param>
-    /// <returns>True if the action should be explored; otherwise, false.</returns>
-    protected override bool ShouldExploreAction( string actionRouteParameterValue, HttpActionDescriptor actionDescriptor, IHttpRoute route, ApiVersion apiVersion )
+    /// <inheritdoc />
+    protected override bool ShouldExploreAction(
+        string actionRouteParameterValue,
+        HttpActionDescriptor actionDescriptor,
+        IHttpRoute route,
+        ApiVersion apiVersion )
     {
         if ( actionDescriptor == null )
         {
@@ -96,15 +94,12 @@ protected override bool ShouldExploreAction( string actionRouteParameterValue, H
         return actionDescriptor.GetApiVersionMetadata().IsMappedTo( apiVersion );
     }
 
-    /// <summary>
-    /// Determines whether the controller should be considered.
-    /// </summary>
-    /// <param name="controllerRouteParameterValue">The controller route parameter value.</param>
-    /// <param name="controllerDescriptor">The associated <see cref="HttpControllerDescriptor">controller descriptor</see>.</param>
-    /// <param name="route">The associated <see cref="IHttpRoute">route</see>.</param>
-    /// <param name="apiVersion">The <see cref="ApiVersion">API version</see> to consider the controller for.</param>
-    /// <returns>True if the controller should be explored; otherwise, false.</returns>
-    protected override bool ShouldExploreController( string controllerRouteParameterValue, HttpControllerDescriptor controllerDescriptor, IHttpRoute route, ApiVersion apiVersion )
+    /// <inheritdoc />
+    protected override bool ShouldExploreController(
+        string controllerRouteParameterValue,
+        HttpControllerDescriptor controllerDescriptor,
+        IHttpRoute route,
+        ApiVersion apiVersion )
     {
         if ( controllerDescriptor == null )
         {
@@ -141,26 +136,26 @@ protected override bool ShouldExploreController( string controllerRouteParameter
         return true;
     }
 
-    /// <summary>
-    /// Explores controllers that do not use direct routes (aka "attribute" routing).
-    /// </summary>
-    /// <param name="controllerMappings">The <see cref="IDictionary{TKey, TValue}">collection</see> of controller mappings.</param>
-    /// <param name="route">The <see cref="IHttpRoute">route</see> to explore.</param>
-    /// <param name="apiVersion">The <see cref="ApiVersion">API version</see> to explore.</param>
-    /// <returns>The <see cref="Collection{T}">collection</see> of discovered <see cref="VersionedApiDescription">API descriptions</see>.</returns>
-    protected override Collection<VersionedApiDescription> ExploreRouteControllers( IDictionary<string, HttpControllerDescriptor> controllerMappings, IHttpRoute route, ApiVersion apiVersion )
+    /// <inheritdoc />
+    protected override Collection<VersionedApiDescription> ExploreRouteControllers(
+        IDictionary<string, HttpControllerDescriptor> controllerMappings,
+        IHttpRoute route,
+        ApiVersion apiVersion )
     {
         if ( controllerMappings == null )
         {
             throw new ArgumentNullException( nameof( controllerMappings ) );
         }
 
+        Collection<VersionedApiDescription> apiDescriptions;
+
         if ( route is not ODataRoute )
         {
-            return base.ExploreRouteControllers( controllerMappings, route, apiVersion );
+            apiDescriptions = base.ExploreRouteControllers( controllerMappings, route, apiVersion );
+            return ExploreQueryOptions( route, apiDescriptions );
         }
 
-        var apiDescriptions = new Collection<VersionedApiDescription>();
+        apiDescriptions = new();
         var modelSelector = Configuration.GetODataRootContainer( route ).GetRequiredService<IEdmModelSelector>();
         var edmModel = modelSelector.SelectModel( apiVersion );
 
@@ -184,17 +179,28 @@ protected override Collection<VersionedApiDescription> ExploreRouteControllers(
             }
         }
 
-        ExploreQueryOptions( apiDescriptions, Configuration.GetODataRootContainer( route ).GetRequiredService<ODataUriResolver>() );
+        return ExploreQueryOptions( route, apiDescriptions );
+    }
 
-        return apiDescriptions;
+    /// <inheritdoc />
+    protected override Collection<VersionedApiDescription> ExploreDirectRouteControllers(
+        HttpControllerDescriptor controllerDescriptor,
+        IReadOnlyList<HttpActionDescriptor> candidateActionDescriptors,
+        IHttpRoute route,
+        ApiVersion apiVersion )
+    {
+        var apiDescriptions = base.ExploreDirectRouteControllers( controllerDescriptor, candidateActionDescriptors, route, apiVersion );
+        return ExploreQueryOptions( route, apiDescriptions );
     }
 
     /// <summary>
     /// Explores the OData query options for the specified API descriptions.
     /// </summary>
     /// <param name="apiDescriptions">The <see cref="IEnumerable{T}">sequence</see> of <see cref="VersionedApiDescription">API descriptions</see> to explore.</param>
     /// <param name="uriResolver">The associated <see cref="ODataUriResolver">OData URI resolver</see>.</param>
-    protected virtual void ExploreQueryOptions( IEnumerable<VersionedApiDescription> apiDescriptions, ODataUriResolver uriResolver )
+    protected virtual void ExploreQueryOptions(
+        IEnumerable<VersionedApiDescription> apiDescriptions,
+        ODataUriResolver uriResolver )
     {
         if ( uriResolver == null )
         {
@@ -206,12 +212,32 @@ protected virtual void ExploreQueryOptions( IEnumerable<VersionedApiDescription>
         {
             NoDollarPrefix = uriResolver.EnableNoDollarQueryOptions,
             DescriptionProvider = queryOptions.DescriptionProvider,
+            DefaultQuerySettings = Configuration.GetDefaultQuerySettings(),
         };
 
         queryOptions.ApplyTo( apiDescriptions, settings );
     }
 
-    private ResponseDescription CreateResponseDescriptionWithRoute( HttpActionDescriptor actionDescriptor, IHttpRoute route, ApiVersion apiVersion )
+    private Collection<VersionedApiDescription> ExploreQueryOptions(
+        IHttpRoute route,
+        Collection<VersionedApiDescription> apiDescriptions )
+    {
+        if ( apiDescriptions.Count == 0 )
+        {
+            return apiDescriptions;
+        }
+
+        var uriResolver = Configuration.GetODataRootContainer( route ).GetRequiredService<ODataUriResolver>();
+
+        ExploreQueryOptions( apiDescriptions, uriResolver );
+
+        return apiDescriptions;
+    }
+
+    private ResponseDescription CreateResponseDescriptionWithRoute(
+        HttpActionDescriptor actionDescriptor,
+        IHttpRoute route,
+        ApiVersion apiVersion )
     {
         var description = CreateResponseDescription( actionDescriptor );
         var serviceProvider = actionDescriptor.Configuration.GetODataRootContainer( route );
@@ -347,7 +373,10 @@ private static bool WillReadUri( HttpParameterBinding parameterBinding )
         return willReadUri;
     }
 
-    private ApiParameterDescription CreateParameterDescriptionFromBinding( HttpParameterBinding parameterBinding, IServiceProvider serviceProvider, ApiVersion apiVersion )
+    private ApiParameterDescription CreateParameterDescriptionFromBinding(
+        HttpParameterBinding parameterBinding,
+        IServiceProvider serviceProvider,
+        ApiVersion apiVersion )
     {
         var descriptor = parameterBinding.Descriptor;
         var description = CreateParameterDescription( descriptor );
@@ -378,7 +407,10 @@ private ApiParameterDescription CreateParameterDescriptionFromBinding( HttpParam
         return description;
     }
 
-    private IList<ApiParameterDescription> CreateParameterDescriptions( HttpActionDescriptor actionDescriptor, IHttpRoute route, ApiVersion apiVersion )
+    private IList<ApiParameterDescription> CreateParameterDescriptions(
+        HttpActionDescriptor actionDescriptor,
+        IHttpRoute route,
+        ApiVersion apiVersion )
     {
         var list = new List<ApiParameterDescription>();
         var actionBinding = GetActionBinding( actionDescriptor );
@@ -422,7 +454,8 @@ private IList<ApiParameterDescription> CreateParameterDescriptions( HttpActionDe
         return list;
     }
 
-    private static IEnumerable<MediaTypeFormatter> GetInnerFormatters( IEnumerable<MediaTypeFormatter> mediaTypeFormatters ) => mediaTypeFormatters.Select( Decorator.GetInner );
+    private static IEnumerable<MediaTypeFormatter> GetInnerFormatters( IEnumerable<MediaTypeFormatter> mediaTypeFormatters ) =>
+        mediaTypeFormatters.Select( Decorator.GetInner );
 
     private static void PopulateMediaTypeFormatters(
        HttpActionDescriptor actionDescriptor,

src/AspNet/OData/src/Asp.Versioning.WebApi.OData.ApiExplorer/Conventions/ODataQueryOptionsConventionBuilder.cs

@@ -16,6 +16,18 @@ private static Type GetController( ApiDescription apiDescription ) =>
         apiDescription.ActionDescriptor.ControllerDescriptor.ControllerType;
 
     [MethodImpl( MethodImplOptions.AggressiveInlining )]
-    private static bool IsODataLike( ApiDescription description ) =>
-        description.ActionDescriptor.GetCustomAttributes<EnableQueryAttribute>( inherit: true ).Count > 0;
+    private static bool IsODataLike( ApiDescription description )
+    {
+        var parameters = description.ParameterDescriptions;
+
+        for ( var i = 0; i < parameters.Count; i++ )
+        {
+            if ( parameters[i].ParameterDescriptor.ParameterType.IsODataQueryOptions() )
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/AspNet/OData/src/Asp.Versioning.WebApi.OData.ApiExplorer/System.Web.Http/HttpConfigurationExtensions.cs

@@ -4,6 +4,7 @@ namespace System.Web.Http;
 
 using Asp.Versioning;
 using Asp.Versioning.ApiExplorer;
+using Microsoft.AspNet.OData.Routing;
 using Microsoft.OData;
 using System.Collections.Concurrent;
 using System.Web.Http.Description;
@@ -15,6 +16,7 @@ namespace System.Web.Http;
 public static class HttpConfigurationExtensions
 {
     private const string RootContainerMappingsKey = "Microsoft.AspNet.OData.RootContainerMappingsKey";
+    private const string NonODataRootContainerKey = "Microsoft.AspNet.OData.NonODataRootContainerKey";
     private const string UrlKeyDelimiterKey = "Microsoft.AspNet.OData.UrlKeyDelimiterKey";
 
     /// <summary>
@@ -69,14 +71,22 @@ private static ODataApiExplorer AddODataApiExplorer( this HttpConfiguration conf
 
     internal static IServiceProvider GetODataRootContainer( this HttpConfiguration configuration, IHttpRoute route )
     {
-        var containers = (ConcurrentDictionary<string, IServiceProvider>) configuration.Properties.GetOrAdd( RootContainerMappingsKey, key => new ConcurrentDictionary<string, IServiceProvider>() );
+        var properties = configuration.Properties;
+        var containers = (ConcurrentDictionary<string, IServiceProvider>) properties.GetOrAdd( RootContainerMappingsKey, key => new ConcurrentDictionary<string, IServiceProvider>() );
         var routeName = configuration.Routes.GetRouteName( route );
 
         if ( !string.IsNullOrEmpty( routeName ) && containers.TryGetValue( routeName!, out var serviceProvider ) )
         {
             return serviceProvider;
         }
 
+        if ( route is not ODataRoute &&
+             properties.TryGetValue( NonODataRootContainerKey, out var value ) &&
+             ( serviceProvider = value as IServiceProvider ) is not null )
+        {
+            return serviceProvider;
+        }
+
         throw new InvalidOperationException( ODataExpSR.NullContainer );
     }
 

src/AspNet/OData/test/Asp.Versioning.WebApi.OData.ApiExplorer.Tests/Conventions/ODataValidationSettingsConventionTest.cs

@@ -3,13 +3,16 @@
 namespace Asp.Versioning.Conventions;
 
 using Asp.Versioning.Description;
+using Asp.Versioning.Simulators.Models;
+using Asp.Versioning.Simulators.V1;
 using Microsoft.AspNet.OData;
 using Microsoft.AspNet.OData.Builder;
 using Microsoft.AspNet.OData.Extensions;
 using Microsoft.AspNet.OData.Query;
 using Microsoft.OData.Edm;
 using System.Collections.ObjectModel;
 using System.Net.Http;
+using System.Reflection;
 using System.Web.Http;
 using System.Web.Http.Controllers;
 using System.Web.Http.Description;
@@ -457,6 +460,97 @@ public void apply_to_should_use_model_bound_query_attributes()
             options => options.ExcludingMissingMembers() );
     }
 
+    [Fact]
+    public void apply_to_should_process_odataX2Dlike_api_description()
+    {
+        // arrange
+        var controllerType = typeof( BooksController );
+        var controllerName = controllerType.Name.Substring( 0, controllerType.Name.Length - 10 );
+        var action = controllerType.GetRuntimeMethods()
+                                   .First( m => m.Name == "Get" && m.GetParameters().Length == 1 );
+        var configuration = new HttpConfiguration();
+        var controllerDescriptor = new HttpControllerDescriptor( configuration, controllerName, controllerType );
+        var actionDescriptor = new ReflectedHttpActionDescriptor( controllerDescriptor, action ) { Configuration = configuration };
+        var parameter = actionDescriptor.GetParameters()[0];
+        var description = new VersionedApiDescription()
+        {
+            ActionDescriptor = actionDescriptor,
+            HttpMethod = HttpMethod.Get,
+            ParameterDescriptions =
+            {
+                new()
+                {
+                    Name = parameter.ParameterName,
+                    ParameterDescriptor = parameter,
+                    Source = Unknown,
+                },
+            },
+            ResponseDescription = new() { ResponseType = typeof( IEnumerable<Book> ) },
+        };
+        var builder = new ODataQueryOptionsConventionBuilder();
+        var settings = new ODataQueryOptionSettings()
+        {
+            DescriptionProvider = builder.DescriptionProvider,
+            DefaultQuerySettings = new(),
+        };
+
+        configuration.EnableDependencyInjection();
+        builder.Controller<BooksController>()
+               .Action( c => c.Get( default ) )
+               .Allow( Select | Count )
+               .AllowOrderBy( "title", "published" );
+
+        // act
+        builder.ApplyTo( new[] { description }, settings );
+
+        // assert
+        description.ParameterDescriptions.RemoveAt( 0 );
+        description.ParameterDescriptions.Should().BeEquivalentTo(
+            new[]
+            {
+                new
+                {
+                    Name = "$select",
+                    Source = FromUri,
+                    ParameterDescriptor = new
+                    {
+                        ParameterName = "$select",
+                        ParameterType = typeof( string ),
+                        Prefix = "$",
+                        IsOptional = true,
+                        DefaultValue = default( object ),
+                    },
+                },
+                new
+                {
+                    Name = "$orderby",
+                    Source = FromUri,
+                    ParameterDescriptor = new
+                    {
+                        ParameterName = "$orderby",
+                        ParameterType = typeof( string ),
+                        Prefix = "$",
+                        IsOptional = true,
+                        DefaultValue = default( object ),
+                    },
+                },
+                new
+                {
+                    Name = "$count",
+                    Source = FromUri,
+                    ParameterDescriptor = new
+                    {
+                        ParameterName = "$count",
+                        ParameterType = typeof( bool ),
+                        Prefix = "$",
+                        IsOptional = true,
+                        DefaultValue = (object) false,
+                    },
+                },
+            },
+            options => options.ExcludingMissingMembers() );
+    }
+
     public static IEnumerable<object[]> EnableQueryAttributeData
     {
         get
@@ -495,7 +589,8 @@ private static ApiDescription NewApiDescription( Type controllerType ) =>
     private static ApiDescription NewApiDescription( Type controllerType, Type responseType, IEdmModel model )
     {
         var configuration = new HttpConfiguration();
-        var controllerDescriptor = new HttpControllerDescriptor( configuration, "Orders", controllerType );
+        var controllerName = controllerType.Name.Substring( 0, controllerType.Name.Length - 10 );
+        var controllerDescriptor = new HttpControllerDescriptor( configuration, controllerName, controllerType );
         var method = controllerType.GetMethod( "Get" );
         var actionDescriptor = new ReflectedHttpActionDescriptor( controllerDescriptor, method ) { Configuration = configuration };
 

src/AspNet/OData/test/Asp.Versioning.WebApi.OData.ApiExplorer.Tests/Simulators/Models/Book.cs

@@ -0,0 +1,14 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+
+namespace Asp.Versioning.Simulators.Models;
+
+public class Book
+{
+    public string Id { get; set; }
+
+    public string Author { get; set; }
+
+    public string Title { get; set; }
+
+    public int Published { get; set; }
+}