首页 > 其他分享 >在 .NET 9 中使用 Scalar 替代 Swagger

在 .NET 9 中使用 Scalar 替代 Swagger

时间:2025-01-14 09:00:49浏览次数:3  
标签:scalar EasySQLite Scalar API https NET 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项目,支持多种编程语言和平台。

  • https://github.com/scalar/scalar

  • https://github.com/scalar/scalar/tree/main/packages/scalar.aspnetcore

下载EasySQLite项目

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

  • 下载地址:https://github.com/YSGStudyHards/EasySQLite

git clone https://github.com/YSGStudyHards/EasySQLite.git

安装 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即可查看效果:

  • https://localhost:7240/scalar/v1

标签:scalar,EasySQLite,Scalar,API,https,NET,Swagger
From: https://blog.csdn.net/qq_37237487/article/details/144973824

相关文章

  • 一个基于.NET开源、灵活易用的内容管理系统
    前言今天大姚给大家分享一个.NET开源、免费(MITLicense)、功能强大、灵活易用的内容管理系统:UmbracoCMS。本文将介绍在.NET中如何使用UmbracoCMS快速构建一个属于自己的内容管理系统。项目介绍UmbracoCMS是一个基于.NET开源、免费(MITLicense)、功能强大、灵活易用的内容管......
  • kea dhcp4 服务报错"No subnet matches interface"的问题分析
    目录环境现象结论环境电脑为Manjaro,KDE环境,已经配置ipv4地址192.168.201.182/24计划使用kea做DHCP服务器,配置新的192.168.182.1ip地址作为DHCPv4服务器地址(原本想直接用配置里的192.0.2.0/24做DHCP服务的)现象设备无法通过电脑获取DHCP地址wireshark看抓包,有DHC......
  • 《Java核心技术II》网络使用telnet
    使用telnettelnet是一种用于网络编程的非常强大的调试工具,可以在命令shell中输入telnet来启动它。注释:在Windows中需要激活它,控制面板->程序->打开/关闭Windows特性->Telnet客户端。连接当日时间服务连接到当日时间服务,由美国国家标准与技术研究所运维,提......
  • 推荐4款基于.NET开源、功能强大的CMS建站系统
    前言CMS系统作为一种强大的内容管理工具,在数字化时代发挥着越来越重要的作用。无论是个人博客还是大型企业官网,选择一个合适的CMS都能极大地提高效率和用户体验。今天大姚给大家推荐4款基于.NET开源、免费、功能强大的CMS建站系统,希望可以帮助到有需要的同学。SSCMSSSCMS内容......
  • kubernetes上安装kubesphere
    准备工作需要配置三台虚拟机关闭防火墙systemctlstopfirewalldsystemctldisablefirewalld临时关闭selinuxsetenforce0永久关闭selinuxvi/etc/selinux/config安装dockerrpm-qa|grepdockeryumremovedocker*-yrpm-qa|grepdockeryuminst......
  • .NET Core 委托原理解析
    .NETCore委托原理解析在.NETCore中,委托(Delegate)是一种类型安全的函数指针,它允许你将方法作为参数传递给其他方法,或者将方法存储在变量中以便稍后调用。委托在事件处理、回调机制以及异步编程中非常有用。理解委托的运行原理对于掌握.NETCore的高级编程技巧至关重要。1.......
  • websocket-sharp:.NET平台上的WebSocket客户端与服务器开源库
    推荐一个C#开发的,实现WebSocket功能的开源项目。01项目简介websocket-sharp提供WebSocket客户端和服务器库,基于C#开发的,并遵循WebSocket协议规范,使得开发人员能够轻松地在.NET应用程序中实现WebSocket通信。websocket-sharp特色功能有:1、简洁易用的API:提供清晰且......
  • 基于YOLOv8与CGNet的鸟类智能识别系统 深度学习图像分类 鸟类目标检测与分类 图像特征
    博主介绍:  ✌我是阿龙,一名专注于Java技术领域的程序员,全网拥有10W+粉丝。作为CSDN特邀作者、博客专家、新星计划导师,我在计算机毕业设计开发方面积累了丰富的经验。同时,我也是掘金、华为云、阿里云、InfoQ等平台的优质作者。通过长期分享和实战指导,我致力于帮助更多学生......
  • .NET Core GC标记阶段(mark_phase)底层原理浅谈
    简介C#采用基于代的回收机制,并使用了更复杂的链式跟踪算法来识别对象是否为垃圾。GC触发的原因截至到.NET8,GC触发的原因有18种enumgc_reason{reason_alloc_soh=0,//小对象堆,快速分配预算不足reason_induced=1,//主动触发GC,没有关于压缩和阻塞的选项r......
  • .NET 开发的分流抢票软件,不做广告、不收集隐私
    前言每年春节大家必备的抢票工具Bypass-分流抢票。分流抢票是一款免费无广适用于PC端的自动分流抢票软件。分流抢票,是以用户为中心、人性化的抢票软件。不做广告、不做推广、不携带病毒、不收集隐私信息,并接受各方技术评测,全心全意为用户打造一款属于自己的抢票软件。项目介绍......