在 .NET 9 中使用 Scalar 替代 Swagger

前言

在.NET 9发布以后ASP.NET Core官方团队发布公告已经将Swashbuckle.AspNetCore(一个为ASP.NET Core API提供Swagger工具的项目)从ASP.NET Core Web API模板中移除,这意味着以后我们创建Web API项目的时候不会再自动生成Swagger API文档了。那么今天咱们一起来试试把我们的EasySQLite .NET 9的项目使用Scalar用于交互式API文档。

Scalar介绍

Scalar是一个功能强大、易于使用的API客户端和文档生成工具,适用于各种规模的API项目,支持多种编程语言和平台。

下载EasySQLite项目

EasySQLite是一个.NET 9操作SQLite入门到实战的详细教程,主要是对学校班级,学生信息进行管理维护。

安装 Scalar.AspNetCore 包

在NuGet包管理器中搜索:Scalar.AspNetCore支持.NET 8和.NET 9)选择安装:

安装 Microsoft.AspNetCore.OpenApi 包

用于添加OpenApi服务,这是Scalar所需的:

在 Program 中配置

            // 添加OpenApi服务,这是Scalar所需的
            builder.Services.AddOpenApi(options =>
            {
                options.AddDocumentTransformer((document, context, cancellationToken) =>
                {
                    document.Info = new()
                    {
                        Title = "EasySQLite API",
                        Version = "V1",
                        Description = ".NET 8操作SQLite入门到实战"
                    };
                    return Task.CompletedTask;
                });
            });
            
            // 在开发环境中启用Scalar
            if (app.Environment.IsDevelopment())
            {
                app.MapScalarApiReference();//映射Scalar的API参考文档路径
                app.MapOpenApi();//映射OpenApi文档路径
            }

查看Scalar交互式API文档

在访问端口后面增加scalar/v1即可查看效果:

相关推荐
JEECG低代码平台1 小时前
【免费开源】积木JimuBI大屏集成eladmin
开源
小众AI2 小时前
Tabby - 开源的自托管 AI 编码助手
人工智能·开源·ai编程
lida20032 小时前
Open FPV VTX开源之ardupilot配置
linux·开源·openipc·msposd
lida20032 小时前
Open FPV VTX开源之betaflight配置
linux·开源·betaflight·openipc·msposd
一只搬砖的猹2 小时前
软件项目开发关键节点——开源合规扫描
测试工具·开源·github·apache·license·软件项目·开源合规
hikktn2 小时前
【开源宝藏】blade-tool AOP请求日志打印
开源
C66668882 小时前
C#格式化输出
开发语言·c#
玉面小君3 小时前
C#图表性能的巅峰之选:LightningChart®.NET
信息可视化·c#·.net
CodeCraft Studio3 小时前
利用.NET版Word处理控件Aspose.Words,使用 C# 在 Word 中创建图表
c#·word·.net
步、步、为营3 小时前
C# 将 List 转换为只读的 List
windows·c#·list