.NET Core WebAPI中封装Swagger配置

这篇具有很好参考价值的文章主要介绍了.NET Core WebAPI中封装Swagger配置。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、创建相关文件

  1. 创建一个Utility/SwaggerExt文件夹,添加一个类
    .NET Core WebAPI中封装Swagger配置,.NET,.netcore,Swagger

二、在Program中找到Swagger相关配置信息

.NET Core WebAPI中封装Swagger配置,.NET,.netcore,Swagger

三、添加方法,在Program中调用

  1. 在SwaggerExt类中添加方法,将相关配置添写入

.NET Core WebAPI中封装Swagger配置,.NET,.netcore,Swagger

/// <summary>
/// swagger配置
/// </summary>
/// <param name="builder"></param>
public static void AddSwaggerExt(this WebApplicationBuilder builder )
{
    builder.Services.AddSwaggerGen();
    // 添加swagger注释
    builder.Services.AddSwaggerGen(x =>
    {
           x.SwaggerDoc("v1", new OpenApiInfo { Title = "Swagger标题", Version = "第一版", Description = ".NET Core WebAPI中使用swagger版本控制,添加注释" });
           var curr = AppContext.BaseDirectory;
           x.IncludeXmlComments(curr + "/WebApplication1.xml", true);
    });
}
/// <summary>
/// 使用Swagger
/// </summary>
/// <param name="app"></param>
public static void UseSwaggerExt(this WebApplication app)
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
  1. 调用封装的方法

.NET Core WebAPI中封装Swagger配置,.NET,.netcore,Swagger文章来源地址https://www.toymoban.com/news/detail-829542.html

 // 调用封装的Swagger配置
//SwaggerExt.AddSwaggerExt(builder);
builder.AddSwaggerExt();

if (app.Environment.IsDevelopment())
{
    app.UseSwaggerExt();
}

到了这里,关于.NET Core WebAPI中封装Swagger配置的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 从零到一搭建netcore6.0 webapi+swagger+jwt认证+aop日志+mysql codefirst模式

    本文介绍从零到一搭建基于netcore6.0版本的 webapi接口应用 包括swagger接口管理文档 jwt接口安全认证 aop接口调用轨迹日志 ef映射mysql 使用codefirst模式交互数据库 首先新建一个webapi应用 此次默认配置HTTPS默认是勾选的 此处没用到暂时不进行勾选 可以删除这2个默认的文件 首先我

    2024年02月04日
    浏览(34)
  • 前后端分离,Asp.net core webapi 简单 2 步,轻松配置跨域

    可以说,前后端分离已经成为当今信息系统项目开发的主流软件架构模式,微服务的出现,让前后端分离发展更是迅速,大量优秀的前端框架如 vue.js、react 的出现,也让前后端分离趋势加快。 所谓的前后端分离软件架构模式,就是指将前端和后端的开发完全分离,后端负责

    2024年01月17日
    浏览(31)
  • 【.net core】获取或排除指定控制器的 Swagger 文档配置

    在api接口开发完成后,我们经常会使用swagger文档配置来查看相关接口信息,有时候也会查看指定某个控制器来生成swagger文档,或是排除某些控制器等操作,如下为示例

    2024年02月12日
    浏览(31)
  • 使用 Asp.net core webapi 集成配置系统,提高程序的灵活和可维护性

    集成配置系统的主要目的是将应用程序的配置信息与代码分离,使得配置信息可以在不需要修改代码的情况下进行更改。这样可以提高应用程序的灵活性和可维护性。 ASP.NET Core 提供了一种灵活的配置系统,可以轻松地将配置信息从不同的来源加载到应用程序中,并且可以根

    2024年02月01日
    浏览(50)
  • .net framework中webapi使用swagger进行接口文档展示

    第一步:在nuget程序包管理中搜索“Swashbuckle”包,然后进行安装(注:如果是.net core api请安装Sawshbuckle aspnetcore)。 第二步:打开项目App_Start文件夹,修改SwaggerConfig.cs配置文件 我这里仅仅是修改swagger文档的标题 第三步:创建主项目的xml注释文档: 右键项目→属性→生成→

    2024年02月07日
    浏览(26)
  • 从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(一)

    1、双击打开VS2022。 2、单击“创建新项目”,如下图。 3、选择“ASP.NET Core Web API”类型,然后单击“下一步”,如下图。 4、“项目名称”此处填写为“AllTestDemo”;“位置”此处放在E盘根目录;“解决方案名称”此处默认与“项目名称”保持一致;不勾选“将解决方案和项

    2023年04月11日
    浏览(50)
  • 从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(二)

    传送门:从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(一) 我们虽然可以在输入 /swagger 后顺利的访问 Swagger UI 页面,但是我们发现每次运行项目都会默认访问 /weatherforecast 这个接口,想要将启动页设为 /swagger (或者其他页面)就需要用到配置文件 launchSettings.

    2023年04月12日
    浏览(35)
  • .Net Core WebApi

    目录 MiniMalAPi Demo Program.cs Swagger 文档+信息 Program.cs API版本控制 ApiVersion.cs Version1Controller.cs Program.cs 生成注释 解决跨域 .Net 后台请求封装 返回数据压缩 默认压缩 Gzip压缩 缓存 接口缓存 静态文件缓存 最小的api, 请求都写在Program.cs中, 可以做微服务 该例子仅供参考 这里其他版

    2024年02月14日
    浏览(35)
  • .Net6 Web Core API 配置 Autofac 封装 --- 依赖注入

    目录 一、NuGet 包导入 二、Autofac 封装类 三、Autofac 使用 四、案例测试 下列封装 采取 程序集注入方法 , 单个依赖注入, 也适用, 可依赖注入的地方配置 Autofac Autofac.Extensions.DependencyInjection Autofac.Extras.DynamicProxy    

    2024年02月14日
    浏览(29)
  • ASP.NET Core SingleR Core:WebApi + .net 客户端开发

    我之前稍微研究了一下SignalR Core。用起来还行。简单来说SignalR就是用来解决实时通讯的问题的。 ASP.NET Core SingleR:初次体验和简单项目搭建 SignalR支持三种客户端,C#,Java,JavaScirpt。基本够用了。本身就是微软开发的,肯定支持自己的语言。因为是Websocket的上层封装,所以也要支

    2024年01月20日
    浏览(50)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包