我是靠谱客的博主 怕孤独长颈鹿,最近开发中收集的这篇文章主要介绍c# webAPI项目 添加 Swagger 调试,觉得挺不错的,现在分享给大家,希望可以做个参考。

概述

c# webAPI项目 添加 Swagger 调试

1.打开工具–>NuGet包管理器–>管理解决方案的NuGet程序包
2.搜索Swashbuckle.AspNeT,安装到webAPI项目中
3.Startup.cs中配置中间件,
1)在public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
后增加
//添加swagger
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v0”, new OpenApiInfo { Title = “测试”, Version = “1.0.0.0” });
//获取xml文件名
var xmlFile = $“{Assembly.GetExecutingAssembly().GetName().Name}.xml”;
//获取xml文件路径
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
//是否显示注释
c.IncludeXmlComments(xmlPath, true);
});

2) 在app.UseRouting();后增加
app.UseSwagger();
app.UseSwaggerUI(c=>
{
c.SwaggerEndpoint(“/swagger/v0/swagger.json”, “测试”);
}
);

4.解决方案中的项目上,右键–>属性–>生成–>输出–>将xml文档文件,打钩,让有xml文件的位置,

  1. 进行分组,在 控制器的文件中 TestController.cs中,类定义的前面
    输入
    [ApiExplorerSettings(GroupName = “v0”)]

  2. 使用:运行项目
    浏览器输入 地址 https://local:2000/swagger/index.html

最后

以上就是怕孤独长颈鹿为你收集整理的c# webAPI项目 添加 Swagger 调试的全部内容,希望文章能够帮你解决c# webAPI项目 添加 Swagger 调试所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。

本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
点赞(68)

评论列表共有 0 条评论

立即
投稿
返回
顶部