.NET中的Swagger使用示例详解

 更新时间:2023年12月25日 15:49:40   作者:我是一只小小鱼~  
Swagger (OpenAPI) 是一个与语言无关的规范,用于描述 REST API,这篇文章给大家介绍.NET中的Swagger使用,感兴趣的朋友一起看看吧

前言

现在很多项目都是前后端分离的项目,后端写好接口跟前端对接,需要后端提供接口文档、参数等注释,这上面花时间着这些东西,接口修改又要去修改文档,很不方便前后端人员开发

一、Swagger是什么?

Swagger (OpenAPI) 是一个与语言无关的规范,用于描述 REST API。

OpenAPI 与 Swagger关系
Swagger 项目已于 2015 年捐赠给 OpenAPI 计划,自此它被称为 OpenAPI,这两个名称可互换使用。 不过,“OpenAPI”指的是规范。
简而言之:
OpenAPI 是一种规范。
Swagger 是一种使用 OpenAPI 规范的工具。 例如,OpenAPIGenerator 和 SwaggerUI。

目前从NETCore从3.1起已经集成Sawwger,无需再去引用库,创建项目后运行API项目自动Sawwger接口文档的页面 

介绍大家可能会关注的一些点

二、如何Swagger文档说明的信息

1.在AddSwaggerGen方法中写入文档信息

代码如下(示例):

builder.Services.AddSwaggerGen(options =>
{
    //诸如作者、文档说明的信息
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "我的API",
        Description = "这是我的netcoreAPI项目",//描述信息
        Contact = new OpenApiContact
        {
            Name = "我是小小鱼",
            Url = new Uri("https://blog.csdn.net/qq_42335551")
        }
    });

2.运行效果

如图(示例):

二、文档UI界面标题、路由设置

如何修改标签页的名、和地址要怎么修改呢

1.在中间件UseSwaggerUI方法中配置

 app.UseSwagger();
    app.UseSwaggerUI(c => { 
        c.DocumentTitle = "后台接口列表";   //标签页标题
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "公共模块");//接口文档json文件
        c.RoutePrefix =string.Empty;// 注:这里的路由修改后,launchSettings.json中的launchUrl对应需要调整为""
    });

 在次启动项目 已经变成修改后的标签页和地址

三、文档UI界面添加接口注释

如何添加接口的注释呢

1.在 .csproj中配置

    在解决方案资源管理器中右键单击该项目。
    将 GenerateDocumentationFile 添加到 .csproj 文件中PropertyGroup节点下

<GenerateDocumentationFile>true</GenerateDocumentationFile>

2.在AddSwaggerGen方法中配置IncludeXmlComments

代码如下(示例):

builder.Services.AddSwaggerGen(options =>
{
    //诸如作者、文档说明的信息
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "我的API",
        Description = "这是我的netcoreAPI项目",//描述信息
        Contact = new OpenApiContact
        {
            Name = "我是小小鱼",
            Url = new Uri("https://blog.csdn.net/qq_42335551")
        }
    });
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);//true 显示控制器注释
});

 运行效果,已经显示出我们的注释

 可以在控制器、参数、实体类增加注释后,再次运行都有显示

四、对接口进行分组

1.在AddSwaggerGen、UseSwaggerUI分别添加如下信息

例如

    options.SwaggerDoc("yw", new OpenApiInfo { Title = "业务模块", Version = "yw" });
    options.SwaggerDoc("qt", new OpenApiInfo { Title = "其他模块", Version = "qt" });

例如

 c.SwaggerEndpoint("/swagger/v1/swagger.json", "公共模块");//接口文档json文件
 c.SwaggerEndpoint("/swagger/yw/swagger.json", "业务模块");
 c.SwaggerEndpoint("/swagger/qt/swagger.json", "其他模块");
 c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.List);//接口不展开None

 2.在controller或者action上打上ApiExplorerSettings特性

例如[ApiExplorerSettings(GroupName = "v1")]

总结

有Sawwger有利于前后端开发人员接口的对接,调试,功能上挺丰富的,简单的写了以上几点

到此这篇关于.NET中的Swagger使用的文章就介绍到这了,更多相关.NET Swagger使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Asp.net禁用页面缓存的方法总结

    Asp.net禁用页面缓存的方法总结

    这篇文章主要介绍了Asp.net禁用页面缓存的方法,需要的朋友可以参考下
    2014-02-02
  • 使用.NET Core实现饿了吗拆红包功能

    使用.NET Core实现饿了吗拆红包功能

    这篇文章主要介绍了使用.NET Core实现饿了吗拆红包功能,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-07-07
  • asp.net内置对象 Response对象使用介绍

    asp.net内置对象 Response对象使用介绍

    这篇文章主要介绍了asp.net内置对象:Response对象使用介绍,对Response对象感兴趣的小伙伴们可以参考一下
    2015-11-11
  • 一个简单的自定义程序日志小样例

    一个简单的自定义程序日志小样例

    前面一篇文章大概说了下自己对日志的一点理解,可能不太直观,这里再附上一个简单的使用例子,以作为对之前的补充,例子比较简单,所以直接看注释即可。
    2009-07-07
  • asp.net2.0中css失效的解决方法

    asp.net2.0中css失效的解决方法

    经常有人遇到ASP.NET 2.0(ASP.NET 1.x中可能是有效的)中CSS失效的问题,现将主要原因和解决方法罗列如下
    2014-01-01
  • asp.net更新指定记录的方法

    asp.net更新指定记录的方法

    这篇文章主要介绍了asp.net更新指定记录的方法,涉及针对指定ID调用update语句的方法,是非常实用的技巧,需要的朋友可以参考下
    2014-11-11
  • ASP.NET编译执行常见错误及解决方法汇总

    ASP.NET编译执行常见错误及解决方法汇总

    ASP.NET编译执行常见错误及解决方法汇总,开发asp.net的朋友可以参考下。方便以后解决一些错误。
    2011-12-12
  • .Net之微信小程序获取用户UnionID的实现

    .Net之微信小程序获取用户UnionID的实现

    这篇文章主要介绍了.Net之微信小程序获取用户UnionID的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • Visual Studio 2015安装步骤详解

    Visual Studio 2015安装步骤详解

    这篇文章主要为大家详细介绍了Visual Studio 2015安装步骤,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • .NET Core单文件发布静态编译AOT CoreRT的方法详解

    .NET Core单文件发布静态编译AOT CoreRT的方法详解

    这篇文章主要给大家介绍了关于.NET Core单文件发布静态编译AOT CoreRT的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-07-07

最新评论