Refactor MapApiGroup to NewVersionedApi (from ASP.NET team feedback)

Author: Chris Martinez

examples/AspNetCore/WebApi/MinimalApiExample/Program.cs

@@ -17,7 +17,7 @@
     "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
 };
 
-var forecast = app.MapApiGroup();
+var forecast = app.NewVersionedApi();
 
 // GET /weatherforecast?api-version=1.0
 forecast.MapGet( "/weatherforecast", () =>

examples/AspNetCore/WebApi/MinimalOpenApiExample/Program.cs

@@ -47,8 +47,8 @@
 
 // Configure the HTTP request pipeline.
 var app = builder.Build();
-var orders = app.MapApiGroup( "Orders" );
-var people = app.MapApiGroup( "People" );
+var orders = app.NewVersionedApi( "Orders" );
+var people = app.NewVersionedApi( "People" );
 
 // 1.0
 var ordersV1 = orders.MapGroup( "/api/orders" )

src/AspNetCore/WebApi/src/Asp.Versioning.Http/Builder/IEndpointConventionBuilderExtensions.cs

@@ -444,7 +444,7 @@ private static void AddMetadata( EndpointBuilder builder, object item )
                 CultureInfo.CurrentCulture,
                 SR.NoVersionSet,
                 builder.DisplayName,
-                nameof( IEndpointRouteBuilderExtensions.MapApiGroup ),
+                nameof( IEndpointRouteBuilderExtensions.NewVersionedApi ),
                 nameof( IEndpointRouteBuilderExtensions.WithApiVersionSet ) ) );
     }
 

src/AspNetCore/WebApi/src/Asp.Versioning.Http/Builder/IEndpointRouteBuilderExtensions.cs

@@ -69,7 +69,7 @@ public static class IEndpointRouteBuilderExtensions
     /// <param name="builder">The extended <see cref="IEndpointRouteBuilder"/>.</param>
     /// <param name="name">The optional name associated with the builder.</param>
     /// <returns>A new <see cref="IVersionedEndpointRouteBuilder"/> instance.</returns>
-    public static IVersionedEndpointRouteBuilder MapApiGroup( this IEndpointRouteBuilder builder, string? name = default )
+    public static IVersionedEndpointRouteBuilder NewVersionedApi( this IEndpointRouteBuilder builder, string? name = default )
     {
         if ( builder is null )
         {

src/AspNetCore/WebApi/src/Asp.Versioning.Http/SR.Designer.cs

@@ -121,7 +121,7 @@
     <value>An API version is required, but was not specified.</value>
   </data>
   <data name="CannotNestApiGroup" xml:space="preserve">
-    <value>An API group cannot be mapped as a nested group.</value>
+    <value>A versioned API group cannot be mapped as a nested group.</value>
   </data>
   <data name="CannotNestVersionSet" xml:space="preserve">
     <value>A grouped API version set cannot be nested under another group.</value>

src/AspNetCore/WebApi/src/Asp.Versioning.Http/SR.resx

@@ -289,7 +289,7 @@ public void with_api_version_set_should_not_override_existing_metadata()
 
         var app = builder.Build();
         var versionSet = new ApiVersionSetBuilder( default ).Build();
-        var group = app.MapApiGroup();
+        var group = app.NewVersionedApi();
         var get = group.MapGet( "/", () => Results.Ok() );
         IEndpointRouteBuilder endpoints = app;
 

src/AspNetCore/WebApi/test/Asp.Versioning.Http.Tests/Builder/IEndpointConventionBuilderExtensionsTest.cs

@@ -72,7 +72,7 @@ public void with_api_version_set_should_not_allow_nesting()
     }
 
     [Fact]
-    public void map_api_group_should_not_be_allowed_multiple_times()
+    public void new_versioned_api_should_not_be_allowed_multiple_times()
     {
         // arrange
         var builder = WebApplication.CreateBuilder();
@@ -84,14 +84,14 @@ public void map_api_group_should_not_be_allowed_multiple_times()
         var app = builder.Build();
 
         // act
-        var mapApiGroup = () => app.MapApiGroup().MapApiGroup();
+        var newVersionedApi = () => app.NewVersionedApi().NewVersionedApi();
 
         // assert
-        mapApiGroup.Should().Throw<InvalidOperationException>();
+        newVersionedApi.Should().Throw<InvalidOperationException>();
     }
 
     [Fact]
-    public void map_api_group_should_not_allow_nesting()
+    public void new_versioned_api_should_not_allow_nesting()
     {
         // arrange
         var builder = WebApplication.CreateBuilder();
@@ -101,13 +101,13 @@ public void map_api_group_should_not_allow_nesting()
         services.AddApiVersioning();
 
         var app = builder.Build();
-        var g1 = app.MapApiGroup();
+        var g1 = app.NewVersionedApi();
         var g2 = g1.MapGroup( "Test" );
 
         // act
-        var mapApiGroup = () => g2.MapApiGroup();
+        var newVersionedApi = () => g2.NewVersionedApi();
 
         // assert
-        mapApiGroup.Should().Throw<InvalidOperationException>();
+        newVersionedApi.Should().Throw<InvalidOperationException>();
     }
 }