.NET Core项目使用swagger开发组件

 更新时间:2022年07月06日 15:04:24   作者:AZRNG  
这篇文章介绍了.NET Core项目使用swagger开发组件的方法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

首先我创建一个。net core项目,我使用的工具是vs2019

这里需要注意的是,看情况选择是否开启身份验证,一般是没有需求的,这里因为我是测试使用所以需要取消勾兑为https配置,并且我没有启用docker支持,因为这个

项目我只是写接口,所以我创建的是一个webapi项目

点击创建,生成项目

因为要使用swagger,所以我们需要安装指定的组件包,现在我们使用nuget安装组件

安装后我们需要去startup中进行配置

首先我们在ConfigureServices中尽心注册swagger服务

//注册swagger服务
services.AddSwaggerGen(c =>
{
// 添加文档信息
c.SwaggerDoc("v1", new Info { Title = "CoreWebApi", Version = "v1" });
});

然后我们在Configure中启用swagger中间件

// 启用Swagger中间件
app.UseSwagger();

// 配置SwaggerUI
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreWebApi");
c.RoutePrefix = string.Empty;
});

接着配置的xml文件

接着我们运行我们的项目

已经看到我们已经出现了swagger的界面,那么我们尝试一下调用

忽然发现我们这个上面并没有每个接口的备注,这是咋回事那?看来我们还需要配置一些东西

我们接着去ConfigureServices中配置

再次运行项目查看

如我们所愿,备注都已经出来了

到此这篇关于.NET Core项目使用swagger开发组件的文章就介绍到这了。希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 关于.NET异常处理的思考总结

    关于.NET异常处理的思考总结

    这篇文章主要介绍了关于.NET异常处理的思考总结,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2016-12-12
  • Asp.Net MVC学习总结之过滤器详解

    Asp.Net MVC学习总结之过滤器详解

    本篇文章主要介绍了Asp.Net MVC学习总结之过滤器详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-03-03
  • ASP.net(c#) 生成html的几种解决方案[思路]

    ASP.net(c#) 生成html的几种解决方案[思路]

    下面的文章转载自网络,其代码很多都有问题,这里只提供给大家一个思路.
    2009-05-05
  • 保护.net中的dll文件方法(防止破解、反编译dll)

    保护.net中的dll文件方法(防止破解、反编译dll)

    .net是一种建立在虚拟机上执行的语言,它直接生成 MSIL 的中间语言,再由.net编译器 JIT 解释映象为本机代码并交付CPU执行。中间语言很容易被反编译,所以研究下如何有效的保护dll文件
    2013-02-02
  • CheckBox控件默认选中,提交时永远获得选中状态的实现代码

    CheckBox控件默认选中,提交时永远获得选中状态的实现代码

    下面小编就为大家带来一篇CheckBox控件默认选中,提交时永远获得选中状态的实现代码。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • 从ASP.NET Core3.1迁移到5.0的方法

    从ASP.NET Core3.1迁移到5.0的方法

    这篇文章主要介绍了从ASP.NET Core3.1迁移到5.0的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • 详解如何在ASP.Net Core中实现健康检查

    详解如何在ASP.Net Core中实现健康检查

    这篇文章主要介绍了详解如何在ASP.Net Core中实现健康检查,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • ASP.NET Core 应用程序中的静态文件中间件的实现

    ASP.NET Core 应用程序中的静态文件中间件的实现

    这篇文章主要介绍了ASP.NET Core 应用程序中的静态文件中间件的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • 浅析ASP.NET万能JSON解析器

    浅析ASP.NET万能JSON解析器

    这篇文章主要是对ASP.NET万能JSON解析器进行了详细的分析介绍,需要的朋友可以过来参考下,希望对大家有所帮助
    2013-12-12
  • IIS上部署你的ASP.NET Core Web Api项目及Swagger(图文)

    IIS上部署你的ASP.NET Core Web Api项目及Swagger(图文)

    本篇经验将和大家介绍如何在IIS上部署ASP.NET Core项目,对大家的学习或者工作具有一定的参考学习价值,希望为初学.NET CORE的童靴入门有所帮助
    2023-09-09

最新评论