Update samples for Endpoint Routing

Author: Chris Martinez

samples/aspnetcore/BasicSample/Startup.cs

@@ -4,6 +4,7 @@
     using Microsoft.AspNetCore.Hosting;
     using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.DependencyInjection;
+    using static Microsoft.AspNetCore.Mvc.CompatibilityVersion;
 
     public class Startup
     {
@@ -17,10 +18,15 @@ public Startup( IConfiguration configuration )
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices( IServiceCollection services )
         {
-            services.AddMvc();
-            
-            // reporting api versions will return the headers "api-supported-versions" and "api-deprecated-versions"
-            services.AddApiVersioning( o => o.ReportApiVersions = true );
+            // the sample application always uses the latest version, but you may want an explict version such as Version_2_2
+            // note: Endpoint Routing is enabled by default; however, if you need legacy style routing via IRouter, change it to false
+            services.AddMvc( options => options.EnableEndpointRouting = true ).SetCompatibilityVersion( Latest );
+            services.AddApiVersioning(
+                options =>
+                {
+                    // reporting api versions will return the headers "api-supported-versions" and "api-deprecated-versions"
+                    options.ReportApiVersions = true;
+                } );
         }
 
         public void Configure( IApplicationBuilder app, IHostingEnvironment env )

samples/aspnetcore/ByNamespaceSample/Startup.cs

@@ -5,6 +5,7 @@
     using Microsoft.AspNetCore.Mvc.Versioning.Conventions;
     using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.DependencyInjection;
+    using static Microsoft.AspNetCore.Mvc.CompatibilityVersion;
 
     public class Startup
     {
@@ -18,7 +19,9 @@ public Startup( IConfiguration configuration )
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices( IServiceCollection services )
         {
-            services.AddMvc();
+            // the sample application always uses the latest version, but you may want an explict version such as Version_2_2
+            // note: Endpoint Routing is enabled by default; however, if you need legacy style routing via IRouter, change it to false
+            services.AddMvc( options => options.EnableEndpointRouting = true ).SetCompatibilityVersion( Latest );
             services.AddApiVersioning(
                 options =>
                 {

samples/aspnetcore/ConventionsSample/Startup.cs

@@ -7,6 +7,7 @@
     using Microsoft.AspNetCore.Mvc.Versioning.Conventions;
     using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.DependencyInjection;
+    using static Microsoft.AspNetCore.Mvc.CompatibilityVersion;
 
     public class Startup
     {
@@ -20,7 +21,9 @@ public Startup( IConfiguration configuration )
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices( IServiceCollection services )
         {
-            services.AddMvc();
+            // the sample application always uses the latest version, but you may want an explict version such as Version_2_2
+            // note: Endpoint Routing is enabled by default; however, if you need legacy style routing via IRouter, change it to false
+            services.AddMvc( options => options.EnableEndpointRouting = true ).SetCompatibilityVersion( Latest );
             services.AddApiVersioning(
                 options =>
                 {

samples/aspnetcore/ODataBasicSample/Startup.cs

@@ -6,6 +6,7 @@
     using Microsoft.AspNetCore.Hosting;
     using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.DependencyInjection;
+    using static Microsoft.AspNetCore.Mvc.CompatibilityVersion;
 
     public class Startup
     {
@@ -19,10 +20,15 @@ public Startup( IConfiguration configuration )
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices( IServiceCollection services )
         {
-            services.AddMvc();
-
-            // reporting api versions will return the headers "api-supported-versions" and "api-deprecated-versions"
-            services.AddApiVersioning( options => options.ReportApiVersions = true );
+            // the sample application always uses the latest version, but you may want an explict version such as Version_2_2
+            // note: Endpoint Routing is enabled by default; however, it is unsupported by OData and MUST be false
+            services.AddMvc( options => options.EnableEndpointRouting = false ).SetCompatibilityVersion( Latest );
+            services.AddApiVersioning(
+                options =>
+                {
+                    // reporting api versions will return the headers "api-supported-versions" and "api-deprecated-versions"
+                    options.ReportApiVersions = true;
+                } );
             services.AddOData().EnableApiVersioning();
         }
 

samples/aspnetcore/SwaggerODataSample/Startup.cs

@@ -13,6 +13,7 @@
     using System.IO;
     using System.Reflection;
     using static Microsoft.AspNet.OData.Query.AllowedQueryOptions;
+    using static Microsoft.AspNetCore.Mvc.CompatibilityVersion;
 
     /// <summary>
     /// Represents the startup process for the application.
@@ -25,7 +26,9 @@ public class Startup
         /// <param name="services">The collection of services to configure the application with.</param>
         public void ConfigureServices( IServiceCollection services )
         {
-            services.AddMvc();
+            // the sample application always uses the latest version, but you may want an explict version such as Version_2_2
+            // note: Endpoint Routing is enabled by default; however, it is unsupported by OData and MUST be false
+            services.AddMvc( options => options.EnableEndpointRouting = false ).SetCompatibilityVersion( Latest );
             services.AddApiVersioning( options => options.ReportApiVersions = true );
             services.AddOData().EnableApiVersioning();
             services.AddODataApiExplorer(
@@ -107,7 +110,7 @@ static Info CreateInfoForApiVersion( ApiVersionDescription description )
         {
             var info = new Info()
             {
-                Title = $"Sample API {description.ApiVersion}",
+                Title = "Sample API",
                 Version = description.ApiVersion.ToString(),
                 Description = "A sample application with Swagger, Swashbuckle, and API versioning.",
                 Contact = new Contact() { Name = "Bill Mei", Email = "bill.mei@somewhere.com" },

samples/aspnetcore/SwaggerSample/Startup.cs

@@ -9,6 +9,7 @@
     using Swashbuckle.AspNetCore.Swagger;
     using System.IO;
     using System.Reflection;
+    using static Microsoft.AspNetCore.Mvc.CompatibilityVersion;
 
     /// <summary>
     /// Represents the startup process for the application.
@@ -36,20 +37,26 @@ public Startup( IConfiguration configuration )
         /// <param name="services">The collection of services to configure the application with.</param>
         public void ConfigureServices( IServiceCollection services )
         {
-            // add the versioned api explorer, which also adds IApiVersionDescriptionProvider service
-            // note: the specified format code will format the version as "'v'major[.minor][-status]"
+            // the sample application always uses the latest version, but you may want an explict version such as Version_2_2
+            // note: Endpoint Routing is enabled by default; however, if you need legacy style routing via IRouter, change it to false
+            services.AddMvc( options => options.EnableEndpointRouting = true ).SetCompatibilityVersion( Latest );
+            services.AddApiVersioning(
+                options =>
+                {
+                    // reporting api versions will return the headers "api-supported-versions" and "api-deprecated-versions"
+                    options.ReportApiVersions = true;
+                } );
             services.AddVersionedApiExplorer(
                 options =>
                 {
+                    // add the versioned api explorer, which also adds IApiVersionDescriptionProvider service
+                    // note: the specified format code will format the version as "'v'major[.minor][-status]"
                     options.GroupNameFormat = "'v'VVV";
 
                     // note: this option is only necessary when versioning by url segment. the SubstitutionFormat
                     // can also be used to control the format of the API version in route templates
                     options.SubstituteApiVersionInUrl = true;
                 } );
-
-            services.AddMvc();
-            services.AddApiVersioning( options => options.ReportApiVersions = true );
             services.AddSwaggerGen(
                 options =>
                 {
@@ -110,7 +117,7 @@ static Info CreateInfoForApiVersion( ApiVersionDescription description )
         {
             var info = new Info()
             {
-                Title = $"Sample API {description.ApiVersion}",
+                Title = "Sample API",
                 Version = description.ApiVersion.ToString(),
                 Description = "A sample application with Swagger, Swashbuckle, and API versioning.",
                 Contact = new Contact() { Name = "Bill Mei", Email = "bill.mei@somewhere.com" },

samples/aspnetcore/SwaggerSample/V1/Controllers/OrdersController.cs

@@ -20,6 +20,7 @@ public class OrdersController : ControllerBase
         /// <response code="200">The order was successfully retrieved.</response>
         /// <response code="404">The order does not exist.</response>
         [HttpGet( "{id:int}", Name = "GetOrderById" )]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( Order ), 200 )]
         [ProducesResponseType( 404 )]
         public IActionResult Get( int id ) => Ok( new Order() { Id = id, Customer = "John Doe" } );
@@ -33,6 +34,7 @@ public class OrdersController : ControllerBase
         /// <response code="400">The order is invalid.</response>
         [HttpPost]
         [MapToApiVersion( "1.0" )]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( Order ), 201 )]
         [ProducesResponseType( 400 )]
         public IActionResult Post( [FromBody] Order order )

samples/aspnetcore/SwaggerSample/V1/Controllers/PeopleController.cs

@@ -21,6 +21,7 @@ public class PeopleController : ControllerBase
         /// <response code="200">The person was successfully retrieved.</response>
         /// <response code="404">The person does not exist.</response>
         [HttpGet( "{id:int}" )]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( Person ), 200 )]
         [ProducesResponseType( 404 )]
         public IActionResult Get( int id ) =>

samples/aspnetcore/SwaggerSample/V2/Controllers/OrdersController.cs

@@ -21,6 +21,7 @@ public class OrdersController : ControllerBase
         /// <returns>All available orders.</returns>
         /// <response code="200">The successfully retrieved orders.</response>
         [HttpGet]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( IEnumerable<Order> ), 200 )]
         public IActionResult Get()
         {
@@ -42,6 +43,7 @@ public IActionResult Get()
         /// <response code="200">The order was successfully retrieved.</response>
         /// <response code="404">The order does not exist.</response>
         [HttpGet( "{id:int}", Name = ByIdRouteName )]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( Order ), 200 )]
         [ProducesResponseType( 400 )]
         [ProducesResponseType( 404 )]
@@ -55,6 +57,7 @@ public IActionResult Get()
         /// <response code="201">The order was successfully placed.</response>
         /// <response code="400">The order is invalid.</response>
         [HttpPost]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( Order ), 201 )]
         [ProducesResponseType( 400 )]
         public IActionResult Post( [FromBody] Order order )

samples/aspnetcore/SwaggerSample/V2/Controllers/PeopleController.cs

@@ -21,6 +21,7 @@ public class PeopleController : ControllerBase
         /// <returns>All available people.</returns>
         /// <response code="200">The successfully retrieved people.</response>
         [HttpGet]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( IEnumerable<Person> ), 200 )]
         public IActionResult Get()
         {
@@ -60,6 +61,7 @@ public IActionResult Get()
         /// <response code="200">The person was successfully retrieved.</response>
         /// <response code="404">The person does not exist.</response>
         [HttpGet( "{id:int}", Name = ByIdRouteName )]
+        [Produces( "application/json" )]
         [ProducesResponseType( typeof( Person ), 200 )]
         [ProducesResponseType( 404 )]
         public IActionResult Get( int id ) =>