updated namespaces and versioning

Author: FabianGosebrink

SampleWebApiAspNetCore/ConfigureSwaggerOptions.cs

@@ -0,0 +1,40 @@
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace SampleWebApiAspNetCore
+{
+    public class ConfigureSwaggerOptions : IConfigureOptions<SwaggerGenOptions>
+    {
+        readonly IApiVersionDescriptionProvider provider;
+
+        public ConfigureSwaggerOptions(IApiVersionDescriptionProvider provider) => this.provider = provider;
+
+        public void Configure(SwaggerGenOptions options)
+        {
+            foreach (var description in provider.ApiVersionDescriptions)
+            {
+                options.SwaggerDoc(description.GroupName, CreateInfoForApiVersion(description));
+            }
+        }
+
+        static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
+        {
+            var info = new OpenApiInfo()
+            {
+                Title = "Sample API",
+                Version = description.ApiVersion.ToString(),
+                Description = "A sample application with Swagger, Swashbuckle, and API versioning.",
+            };
+
+            if (description.IsDeprecated)
+            {
+                info.Description += " This API version has been deprecated.";
+            }
+
+            return info;
+        }
+    }
+}

SampleWebApiAspNetCore/Program.cs

@@ -7,7 +7,7 @@
 using SampleWebApiAspNetCore.Services;
 using System;
 
-namespace WebApplication11
+namespace SampleWebApiAspNetCore
 {
     public class Program
     {

SampleWebApiAspNetCore/Properties/launchSettings.json

@@ -17,7 +17,7 @@
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
-    "WebApplication11": {
+    "SampleWebApiAspNetCore": {
       "commandName": "Project",
       "launchBrowser": true,
       "launchUrl": "swagger",

SampleWebApiAspNetCore/Repositories/EfFoodRepository.cs renamed to SampleWebApiAspNetCore/Repositories/FoodSqlRepository.cs

@@ -8,11 +8,11 @@
 
 namespace SampleWebApiAspNetCore.Repositories
 {
-    public class EfFoodRepository : IFoodRepository
+    public class FoodSqlRepository : IFoodRepository
     {
         private readonly FoodDbContext _foodDbContext;
 
-        public EfFoodRepository(FoodDbContext foodDbContext)
+        public FoodSqlRepository(FoodDbContext foodDbContext)
         {
             _foodDbContext = foodDbContext;
         }

SampleWebApiAspNetCore/Startup.cs

@@ -13,12 +13,14 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 using SampleWebApiAspNetCore.MappingProfiles;
 using SampleWebApiAspNetCore.Repositories;
 using SampleWebApiAspNetCore.Services;
+using Swashbuckle.AspNetCore.SwaggerGen;
 
-namespace WebApplication11
+namespace SampleWebApiAspNetCore
 {
     public class Startup
     {
@@ -47,7 +49,7 @@ public void ConfigureServices(IServiceCollection services)
             });
 
             services.AddSingleton<ISeedDataService, SeedDataService>();
-            services.AddScoped<IFoodRepository, EfFoodRepository>();
+            services.AddScoped<IFoodRepository, FoodSqlRepository>();
             services.AddRouting(options => options.LowercaseUrls = true);
             services.AddSingleton<IActionContextAccessor, ActionContextAccessor>();
             services.AddScoped<IUrlHelper>(x =>
@@ -62,32 +64,25 @@ public void ConfigureServices(IServiceCollection services)
                 .AddNewtonsoftJson()
                 .SetCompatibilityVersion(CompatibilityVersion.Version_3_0);
 
-            services.AddApiVersioning(config =>
-            {
-                config.ReportApiVersions = true;
-                config.AssumeDefaultVersionWhenUnspecified = true;
-                config.DefaultApiVersion = new ApiVersion(1, 0);
-                config.ApiVersionReader = new HeaderApiVersionReader("api-version");
-            });
-
-            services.AddVersionedApiExplorer(o => o.GroupNameFormat = "'v'VVV");
-            services.AddSwaggerGen(
-               options =>
-               {
-                   ServiceProvider serviceProvider = services.BuildServiceProvider();
-                   var provider = serviceProvider.GetRequiredService<IApiVersionDescriptionProvider>();
+             services.AddApiVersioning(
+                config =>
+                {
+                    config.ReportApiVersions = true;
+                    config.AssumeDefaultVersionWhenUnspecified = true;
+                    config.DefaultApiVersion = new ApiVersion(1, 0);
+                    config.ApiVersionReader = new HeaderApiVersionReader("api-version");
+                });
+            services.AddVersionedApiExplorer(
+                options =>
+                {
+                    options.GroupNameFormat = "'v'VVV";
 
-                   foreach (var description in provider.ApiVersionDescriptions)
-                   {
-                       options.SwaggerDoc(
-                           description.GroupName,
-                           new OpenApiInfo()
-                           {
-                               Title = $"Sample API {description.ApiVersion}",
-                               Version = description.ApiVersion.ToString()
-                           });
-                   }
-               });
+                    // 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.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();
+            services.AddSwaggerGen();
 
             services.AddAutoMapper(typeof(FoodMappings));
         }