Add support to automatically explore API version parameters

Author: Chris Martinez

samples/aspnetcore/SwaggerSample/ImplicitApiVersionParameter.cs

@@ -63,8 +63,8 @@ public void ConfigureServices( IServiceCollection services )
                         options.SwaggerDoc( description.GroupName, CreateInfoForApiVersion( description ) );
                     }
 
-                    // add a custom operation filter which documents the implicit API version parameter
-                    options.OperationFilter<ImplicitApiVersionParameter>();
+                    // add a custom operation filter which sets default values
+                    options.OperationFilter<SwaggerDefaultValues>();
 
                     // integrate xml comments
                     options.IncludeXmlComments( XmlCommentsFilePath );

samples/aspnetcore/SwaggerSample/Startup.cs

@@ -0,0 +1,41 @@
+namespace Microsoft.Examples
+{
+    using Swashbuckle.AspNetCore.Swagger;
+    using Swashbuckle.AspNetCore.SwaggerGen;
+    using System.Linq;
+
+    /// <summary>
+    /// Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter.
+    /// </summary>
+    /// <remarks>This <see cref="IOperationFilter"/> is only required due to bugs in the <see cref="SwaggerGenerator"/>.
+    /// Once they are fixed and published, this class can be removed.</remarks>
+    public class SwaggerDefaultValues : IOperationFilter
+    {
+        /// <summary>
+        /// Applies the filter to the specified operation using the given context.
+        /// </summary>
+        /// <param name="operation">The operation to apply the filter to.</param>
+        /// <param name="context">The current operation filter context.</param>
+        public void Apply( Operation operation, OperationFilterContext context )
+        {
+            // REF: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/412
+            // REF: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/pull/413
+            foreach ( var parameter in operation.Parameters.OfType<NonBodyParameter>() )
+            {
+                var description = context.ApiDescription.ParameterDescriptions.First( p => p.Name == parameter.Name );
+                
+                if ( parameter.Description == null )
+                {
+                    parameter.Description = description.ModelMetadata.Description;
+                }
+
+                if ( parameter.Default == null )
+                {
+                    parameter.Default = description.RouteInfo.DefaultValue;
+                }
+
+                parameter.Required |= !description.RouteInfo.IsOptional;
+            }
+        }
+    }
+}

samples/aspnetcore/SwaggerSample/SwaggerDefaultValues.cs

@@ -77,7 +77,7 @@ public void Configuration( IAppBuilder builder )
                                   } );
 
                                // add a custom operation filter which documents the implicit API version parameter
-                               swagger.OperationFilter<ImplicitApiVersionParameter>();
+                               swagger.OperationFilter<SwaggerDefaultValues>();
 
                                // integrate xml comments
                                swagger.IncludeXmlComments( XmlCommentsFilePath );

samples/webapi/SwaggerODataWebApiSample/ImplicitApiVersionParameter.cs

@@ -0,0 +1,46 @@
+namespace Microsoft.Examples
+{
+    using Swashbuckle.Swagger;
+    using System.Linq;
+    using System.Web.Http.Description;
+
+    /// <summary>
+    /// Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter.
+    /// </summary>
+    /// <remarks>This <see cref="IOperationFilter"/> is only required due to bugs in the <see cref="SwaggerGenerator"/>.
+    /// Once they are fixed and published, this class can be removed.</remarks>
+    public class SwaggerDefaultValues : IOperationFilter
+    {
+        /// <summary>
+        /// Applies the filter to the specified operation using the given context.
+        /// </summary>
+        /// <param name="operation">The operation to apply the filter to.</param>
+        /// <param name="schemaRegistry">The API schema registry.</param>
+        /// <param name="apiDescription">The API description being filtered.</param>
+        public void Apply( Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription )
+        {
+            if ( operation.parameters == null )
+            {
+                return;
+            }
+
+            foreach ( var parameter in operation.parameters )
+            {
+                var description = apiDescription.ParameterDescriptions.First( p => p.Name == parameter.name );
+
+                // REF: https://github.com/domaindrivendev/Swashbuckle/issues/1101
+                if ( parameter.description == null )
+                {
+                    parameter.description = description.Documentation;
+                }
+
+                // REF: https://github.com/domaindrivendev/Swashbuckle/issues/1089
+                // REF: https://github.com/domaindrivendev/Swashbuckle/pull/1090
+                if ( parameter.@default == null )
+                {
+                    parameter.@default = description.ParameterDescriptor.DefaultValue;
+                }
+            }
+        }
+    }
+}

samples/webapi/SwaggerODataWebApiSample/Startup.cs

@@ -127,7 +127,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="CaseInsensitiveODataUriResolver.cs" />
-    <Compile Include="ImplicitApiVersionParameter.cs" />
+    <Compile Include="SwaggerDefaultValues.cs" />
     <Compile Include="Configuration\ApiVersions.cs" />
     <Compile Include="Configuration\OrderModelConfiguration.cs" />
     <Compile Include="Configuration\PersonModelConfiguration.cs" />

samples/webapi/SwaggerODataWebApiSample/SwaggerDefaultValues.cs

@@ -60,10 +60,9 @@ public void Configuration( IAppBuilder builder )
                                                 .TermsOfService( "Shareware" );
                                         }
                                     } );
-
-
-                                // add a custom operation filter which documents the implicit API version parameter
-                                swagger.OperationFilter<ImplicitApiVersionParameter>();
+                                
+                                // add a custom operation filter which sets default values
+                                swagger.OperationFilter<SwaggerDefaultValues>();
 
                                 // integrate xml comments
                                 swagger.IncludeXmlComments( XmlCommentsFilePath );