Merge pull request #10 from fossapps/swagger

feat(swagger): add openapi support

Author: cyberhck

Micro.Starter.Api/Controllers/WeatherForecastController.cs

@@ -8,7 +8,7 @@
 namespace Micro.Starter.Api.Controllers
 {
     [ApiController]
-    [Route("api/v{version:apiVersion}/[controller]")]
+    [Route("api/[controller]")]
     public class WeatherForecastController : ControllerBase
     {
         private static readonly string[] Summaries = new[]
@@ -24,7 +24,6 @@ public WeatherForecastController(ILogger<WeatherForecastController> logger)
         }
 
         [HttpGet]
-        [ApiVersion("1", Deprecated = true)]
         [ProducesResponseType(typeof(IEnumerable<WeatherForecast>), StatusCodes.Status200OK)]
         public IEnumerable<WeatherForecast> Get()
         {
@@ -37,20 +36,5 @@ public IEnumerable<WeatherForecast> Get()
                 })
                 .ToArray();
         }
-
-        [HttpGet]
-        [ApiVersion("2")]
-        [ProducesResponseType(typeof(IEnumerable<WeatherForecast>), StatusCodes.Status200OK)]
-        public IEnumerable<WeatherForecast> GetNewVersion()
-        {
-            var rng = new Random();
-            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
-                {
-                    Date = DateTime.Now.AddDays(index),
-                    TemperatureC = rng.Next(-20, 55),
-                    Summary = Summaries[rng.Next(Summaries.Length)]
-                })
-                .ToArray();
-        }
     }
 }

Micro.Starter.Api/Micro.Starter.Api.csproj

@@ -9,12 +9,12 @@
       <PackageReference Include="App.Metrics.AspNetCore.Mvc" Version="3.2.0-dev0002" />
       <PackageReference Include="App.Metrics.Extensions.Configuration" Version="3.2.0-dev0002" />
       <PackageReference Include="App.Metrics.Reporting.InfluxDB" Version="3.2.0-dev0002" />
-      <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="4.0.0-preview8.19405.7" />
       <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.0.0-preview8.19405.11" />
       <PackageReference Include="Microsoft.Extensions.Logging.Slack" Version="1.1.0" />
       <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="3.0.0-preview8" />
       <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL.Design" Version="1.1.1" />
       <None Include="./appsettings.ci.json" CopyToPublishDirectory="Always" />
+      <PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0-rc2" />
     </ItemGroup>
 
     <Target Name="Install githooks" BeforeTargets="Build">

Micro.Starter.Api/Startup.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Linq;
 using Micro.Starter.Api.Configs;
 using Micro.Starter.Api.Models;
 using Micro.Starter.Api.Repository;
@@ -13,6 +14,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Slack;
 using Microsoft.Extensions.Options;
+using Microsoft.OpenApi.Models;
 
 namespace Micro.Starter.Api
 {
@@ -32,12 +34,14 @@ public void ConfigureServices(IServiceCollection services)
             services.AddMetrics();
             ConfigureDependencies(services);
             services.AddControllers();
-            services.AddApiVersioning(x =>
+            services.AddSwaggerGen(c =>
             {
-                x.DefaultApiVersion = new ApiVersion(1, 0);
-                x.RegisterMiddleware = true;
-                x.ReportApiVersions = true;
-                x.AssumeDefaultVersionWhenUnspecified = true;
+                c.ResolveConflictingActions(apiDescription => apiDescription.Last());
+                c.SwaggerDoc("v1", new OpenApiInfo
+                {
+                    Title = "Title",
+                    Version = "v1"
+                });
             });
             RegisterWorker(services);
         }
@@ -73,6 +77,12 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerF
 
             app.UseAuthorization();
 
+            app.UseSwagger();
+            app.UseSwaggerUI(x =>
+            {
+                x.RoutePrefix = "swagger";
+                x.SwaggerEndpoint("/swagger/v1/swagger.json", "V1");
+            });
             app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
         }