feat: use OpenApi and Scalar instead swagger

Author: WeihanLi

Directory.Packages.props

@@ -6,12 +6,13 @@
   <ItemGroup>
     <PackageVersion Condition="'$(TargetFramework)'=='net8.0'" Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.11" />
     <PackageVersion Condition="'$(TargetFramework)'=='net9.0'" Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="9.0.0" />
-    <PackageVersion Include="Swashbuckle.AspNetCore" Version="7.0.0" />
+    <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
+    <PackageVersion Include="Scalar.AspNetCore" Version="1.2.36" />
     <PackageVersion Include="WeihanLi.Common" Version="1.0.72" />
   </ItemGroup>
   <ItemGroup>
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
     <PackageVersion Include="xunit" Version="2.9.2" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
   </ItemGroup>
-</Project>
+</Project>

samples/WeihanLi.Web.Extensions.Samples/Program.cs

@@ -3,6 +3,7 @@
 
 using Microsoft.IdentityModel.Tokens;
 using Microsoft.OpenApi.Models;
+using Scalar.AspNetCore;
 using System.Reflection;
 using System.Text.Json.Serialization;
 using WeihanLi.Common.Aspect;
@@ -71,18 +72,10 @@
 });
 builder.Services.AddHttpContextUserIdProvider(options =>
 {
-    options.UserIdFactory = context => $"{context.GetUserIP()}";
+    options.UserIdFactory = static context => $"{context.GetUserIP()}";
 });
 builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddSwaggerGen(options =>
-{
-    options.SwaggerDoc("v1", new OpenApiInfo
-    {
-        Version = "v1",
-        Title = "v1 API docs"
-    });
-    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"), true);
-});
+builder.Services.AddOpenApi();
 
 builder.Host.UseFluentAspectsServiceProviderFactory(options =>
     {
@@ -131,11 +124,9 @@
 // envGroup.Map("/stage", [EnvironmentFilter("Staging")]() => "env-test");
 
 app.UseHealthCheck();
-app.UseSwagger().UseSwaggerUI(options =>
-{
-    options.RoutePrefix = string.Empty;
-    options.SwaggerEndpoint("/swagger/v1/swagger.json", "v1");
-});
+
+app.MapOpenApi();
+app.MapScalarApiReference();
 
 app.UseAuthentication();
 app.UseAuthorization();
@@ -191,6 +182,6 @@
 await app.RunAsync();
 
 
-string Hello() => "Hello Minimal API!";
+static string Hello() => "Hello Minimal API!";
 
-IResult BadRequest() => Results.BadRequest();
+static IResult BadRequest() => Results.BadRequest();

samples/WeihanLi.Web.Extensions.Samples/WeihanLi.Web.Extensions.Samples.csproj

@@ -11,6 +11,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Swashbuckle.AspNetCore" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" />
+    <PackageReference Include="Scalar.AspNetCore" />
   </ItemGroup>
 </Project>