Complete update web API examples

Author: commonsensesoftware

examples/AspNetCore/WebApi/MinimalApiExample/Program.cs

@@ -1,3 +1,5 @@
+using Asp.Versioning;
+
 var builder = WebApplication.CreateBuilder( args );
 
 // Add services to the container.
@@ -36,7 +38,7 @@
 var v2 = forecast.MapGroup( "/weatherforecast" )
                  .HasApiVersion( 2.0 );
 
-v2.MapGet( "/", () =>
+v2.MapGet( "/", ( ApiVersion version ) =>
    {
        return Enumerable.Range( 0, summaries.Length ).Select( index =>
            new WeatherForecast

examples/AspNetCore/WebApi/MinimalOpenApiExample/ConfigureSwaggerOptions.cs

@@ -17,10 +17,16 @@
                 // "api-supported-versions" and "api-deprecated-versions"
                 options.ReportApiVersions = true;
 
+                options.Policies.Deprecate( 0.9 )
+                                .Effective( DateTimeOffset.Now )
+                                .Link( "policy.html" )
+                                    .Title( "Version Deprecation Policy" )
+                                    .Type( "text/html" );
+
                 options.Policies.Sunset( 0.9 )
                                 .Effective( DateTimeOffset.Now.AddDays( 60 ) )
                                 .Link( "policy.html" )
-                                    .Title( "Versioning Policy" )
+                                    .Title( "Version Sunset Policy" )
                                     .Type( "text/html" );
             } )
         .AddApiExplorer(
@@ -34,10 +40,7 @@
                 // can also be used to control the format of the API version in route templates
                 options.SubstituteApiVersionInUrl = true;
             } )
-        .AddOpenApi( options => options.Document.AddScalarTransformers() )
-        // this enables binding ApiVersion as a endpoint callback parameter. if you don't use it, then
-        // you should remove this configuration.
-        .EnableApiVersionBinding();
+        .AddOpenApi( options => options.Document.AddScalarTransformers() );
 
 var app = builder.Build();
 

examples/AspNetCore/WebApi/MinimalOpenApiExample/Program.cs

@@ -1,4 +1,6 @@
-namespace ApiVersioning.Examples.Services;
+using Asp.Versioning;
+
+namespace ApiVersioning.Examples.Services;
 
 /// <summary>
 /// Provides the endpoint extensions for the Orders service.
@@ -95,7 +97,7 @@ public void ToV3()
 
             api.MapPost( "/", V3.Post )
                .Accepts( orders.ModelType, "application/json" )
-               .Produces( 201 , orders.ModelType )
+               .Produces( 201, orders.ModelType )
                .Produces( 400 );
 
             api.MapDelete( "/{id:int}", V3.Delete )
@@ -158,9 +160,10 @@ public static class V2
         /// Get Orders
         /// </summary>
         /// <description>Retrieves all orders.</description>
+        /// <param name="version"></param>
         /// <returns>All available orders.</returns>
         /// <response code="200">The successfully retrieved orders.</response>
-        public static Models.V2.Order[] GetAll() =>
+        public static Models.V2.Order[] GetAll( ApiVersion version ) =>
         [
             new (){ Id = 1, Customer = "John Doe" },
             new (){ Id = 2, Customer = "Bob Smith" },
@@ -172,10 +175,11 @@ public static Models.V2.Order[] GetAll() =>
         /// </summary>
         /// <description>Gets a single order.</description>
         /// <param name="id">The requested order identifier.</param>
+        /// <param name="version"></param>
         /// <returns>The requested order.</returns>
         /// <response code="200">The order was successfully retrieved.</response>
         /// <response code="404">The order does not exist.</response>
-        public static Models.V2.Order GetById( int id ) => new() { Id = id, Customer = "John Doe" };
+        public static Models.V2.Order GetById( int id, ApiVersion version ) => new() { Id = id, Customer = "John Doe" };
 
         /// <summary>
         /// Place Order