Fix Swagger UI for Kestrel web server

Dominik Oswald · Dominik Oswald · commit 900fe837163f · 2020-04-28T18:58:53.000+02:00
Update to Abp 5.6
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Core/AbpCompanyName.AbpProjectName.Core.csproj b/aspnet-core/src/AbpCompanyName.AbpProjectName.Core/AbpCompanyName.AbpProjectName.Core.csproj
@@ -18,8 +18,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Abp.AutoMapper" Version="5.4.0" />
-    <PackageReference Include="Abp.ZeroCore.EntityFrameworkCore" Version="5.4.0" />
+    <PackageReference Include="Abp.AutoMapper" Version="5.6.0" />
+    <PackageReference Include="Abp.ZeroCore.EntityFrameworkCore" Version="5.6.0" />
     <PackageReference Include="Castle.Windsor.MsDependencyInjection" Version="3.3.1" />
   </ItemGroup>
 
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.EntityFrameworkCore/AbpCompanyName.AbpProjectName.EntityFrameworkCore.csproj b/aspnet-core/src/AbpCompanyName.AbpProjectName.EntityFrameworkCore/AbpCompanyName.AbpProjectName.EntityFrameworkCore.csproj
@@ -16,12 +16,12 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.0" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="3.1.0">
+    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.3" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="3.1.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.0">
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Migrator/AbpCompanyName.AbpProjectName.Migrator.csproj b/aspnet-core/src/AbpCompanyName.AbpProjectName.Migrator/AbpCompanyName.AbpProjectName.Migrator.csproj
@@ -18,7 +18,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Abp.Castle.Log4Net" Version="5.4.0" />
+    <PackageReference Include="Abp.Castle.Log4Net" Version="5.6.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Core/AbpCompanyName.AbpProjectName.Web.Core.csproj b/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Core/AbpCompanyName.AbpProjectName.Web.Core.csproj
@@ -25,11 +25,11 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.0" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0-rc4" />
-    <PackageReference Include="Abp.AspNetCore" Version="5.4.0" />
-    <PackageReference Include="Abp.ZeroCore" Version="5.4.0" />
-    <PackageReference Include="Abp.AspNetCore.SignalR" Version="5.4.0" />
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.4.0" />
+    <PackageReference Include="Abp.AspNetCore" Version="5.6.0" />
+    <PackageReference Include="Abp.ZeroCore" Version="5.6.0" />
+    <PackageReference Include="Abp.AspNetCore.SignalR" Version="5.6.0" />
   </ItemGroup>
 
 </Project>
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/AbpCompanyName.AbpProjectName.Web.Host.csproj b/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/AbpCompanyName.AbpProjectName.Web.Host.csproj
@@ -36,8 +36,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Abp.Castle.Log4Net" Version="5.4.0" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.0">
+    <PackageReference Include="Abp.Castle.Log4Net" Version="5.6.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/Startup/Program.cs b/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/Startup/Program.cs
@@ -1,5 +1,7 @@
 ﻿using Microsoft.AspNetCore;
 using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using System.IO;
 
 namespace AbpCompanyName.AbpProjectName.Web.Host.Startup
 {
@@ -12,8 +14,14 @@ public static void Main(string[] args)
 
         public static IWebHost BuildWebHost(string[] args)
         {
+            var config = new ConfigurationBuilder()
+               .SetBasePath(Directory.GetCurrentDirectory())
+               .AddJsonFile("appsettings.json", optional: false)
+               .Build();
+
             return WebHost.CreateDefaultBuilder(args)
                 .UseStartup<Startup>()
+                .UseUrls(config.GetValue<string>("App:ServerRootAddress"))
                 .Build();
         }
     }
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/Startup/Startup.cs b/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/Startup/Startup.cs
@@ -25,6 +25,8 @@ public class Startup
     {
         private const string _defaultCorsPolicyName = "localhost";
 
+        private const string _apiVersion = "v1";
+
         private readonly IConfigurationRoot _appConfiguration;
 
         public Startup(IWebHostEnvironment env)
@@ -76,9 +78,9 @@ public IServiceProvider ConfigureServices(IServiceCollection services)
             // Swagger - Enable this line and the related lines in Configure method to enable swagger UI
             services.AddSwaggerGen(options =>
             {
-                options.SwaggerDoc("v1", new OpenApiInfo
+                options.SwaggerDoc(_apiVersion, new OpenApiInfo
                 {
-                    Version = "v1",
+                    Version = _apiVersion,
                     Title = "AbpProjectName API",
                     Description = "AbpProjectName",
                     // uncomment if needed TermsOfService = new Uri("https://example.com/terms"),
@@ -142,7 +144,8 @@ public void Configure(IApplicationBuilder app,  ILoggerFactory loggerFactory)
             // Enable middleware to serve swagger-ui assets (HTML, JS, CSS etc.)
             app.UseSwaggerUI(options =>
             {
-                options.SwaggerEndpoint(_appConfiguration["App:ServerRootAddress"].EnsureEndsWith('/') + "swagger/v1/swagger.json", "AbpProjectName API V1");
+                // specifying the Swagger JSON endpoint.
+                options.SwaggerEndpoint($"/swagger/{_apiVersion}/swagger.json", $"AbpProjectName API {_apiVersion}");
                 options.IndexStream = () => Assembly.GetExecutingAssembly()
                     .GetManifestResourceStream("AbpCompanyName.AbpProjectName.Web.Host.wwwroot.swagger.ui.index.html");
                 options.DisplayRequestDuration(); // Controls the display of the request duration (in milliseconds) for "Try it out" requests.  
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Mvc/AbpCompanyName.AbpProjectName.Web.Mvc.csproj b/aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Mvc/AbpCompanyName.AbpProjectName.Web.Mvc.csproj
@@ -35,16 +35,16 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="BuildBundlerMinifier" Version="3.2.435" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" Version="3.1.1" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.0">
+    <PackageReference Include="BuildBundlerMinifier" Version="3.2.447" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" Version="3.1.3" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="3.1.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="PaulMiami.AspNetCore.Mvc.Recaptcha" Version="1.2.1" />
-    <PackageReference Include="Abp.HangFire" Version="5.4.0" />
-    <PackageReference Include="Abp.RedisCache" Version="5.4.0" />
-    <PackageReference Include="Abp.Castle.Log4Net" Version="5.4.0" />
+    <PackageReference Include="PaulMiami.AspNetCore.Mvc.Recaptcha" Version="1.2.2" />
+    <PackageReference Include="Abp.HangFire" Version="5.6.0" />
+    <PackageReference Include="Abp.RedisCache" Version="5.6.0" />
+    <PackageReference Include="Abp.Castle.Log4Net" Version="5.6.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/aspnet-core/test/AbpCompanyName.AbpProjectName.Tests/AbpCompanyName.AbpProjectName.Tests.csproj b/aspnet-core/test/AbpCompanyName.AbpProjectName.Tests/AbpCompanyName.AbpProjectName.Tests.csproj
@@ -18,7 +18,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
     <PackageReference Include="NSubstitute" Version="4.2.1" />
     <PackageReference Include="Shouldly" Version="3.0.2" />
     <PackageReference Include="xunit" Version="2.4.1" />
@@ -27,8 +27,8 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Abp.TestBase" Version="5.4.0" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="3.1.0" />
+    <PackageReference Include="Abp.TestBase" Version="5.6.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="3.1.3" />
     <PackageReference Include="Castle.Core" Version="4.4.0" />
   </ItemGroup>
 
diff --git a/aspnet-core/test/AbpCompanyName.AbpProjectName.Web.Tests/AbpCompanyName.AbpProjectName.Web.Tests.csproj b/aspnet-core/test/AbpCompanyName.AbpProjectName.Web.Tests/AbpCompanyName.AbpProjectName.Web.Tests.csproj
@@ -18,7 +18,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
         <PackageReference Include="NSubstitute" Version="4.2.1" />
         <PackageReference Include="Shouldly" Version="3.0.2" />
         <PackageReference Include="xunit" Version="2.4.1" />
@@ -27,10 +27,10 @@
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="Abp.AspNetCore.TestBase" Version="5.4.0" />
-        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="3.1.0" />
+        <PackageReference Include="Abp.AspNetCore.TestBase" Version="5.6.0" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="3.1.3" />
         <PackageReference Include="Castle.Core" Version="4.4.0" />
-        <PackageReference Include="AngleSharp" Version="0.13.0" />
+        <PackageReference Include="AngleSharp" Version="0.14.0" />
     </ItemGroup>
 
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`using Microsoft.AspNetCore;`
`2`	`2`	`using Microsoft.AspNetCore.Hosting;`
	`3`	`+using Microsoft.Extensions.Configuration;`
	`4`	`+using System.IO;`
`3`	`5`
`4`	`6`	`namespace AbpCompanyName.AbpProjectName.Web.Host.Startup`
`5`	`7`	`{`
`@@ -12,8 +14,14 @@ public static void Main(string[] args)`
`12`	`14`
`13`	`15`	`public static IWebHost BuildWebHost(string[] args)`
`14`	`16`	`{`
	`17`	`+ var config = new ConfigurationBuilder()`
	`18`	`+ .SetBasePath(Directory.GetCurrentDirectory())`
	`19`	`+ .AddJsonFile("appsettings.json", optional: false)`
	`20`	`+ .Build();`
	`21`	`+`
`15`	`22`	`return WebHost.CreateDefaultBuilder(args)`
`16`	`23`	`.UseStartup<Startup>()`
	`24`	`+ .UseUrls(config.GetValue<string>("App:ServerRootAddress"))`
`17`	`25`	`.Build();`
`18`	`26`	`}`
`19`	`27`	`}`