C#asp.net core 给swagger配置注释详细操作

本文介绍了如何在ASP.NETCore项目中启用SwaggerUI界面,通过中间件配置包含XML注释,并在API接口上添加详细的描述。步骤包括设置XML文件生成、替换中间件代码以及添加接口注解。
摘要由CSDN通过智能技术生成

1.创建asp.net core api 项目

在初始项目中默认已经集成了swaggerUI的界面

这里采用的是中间件的形式进行调用

UI界面如下

2.给swagger添加注释的操作,首先点击项目窗体项目呼出属性

勾选以下内容,编译是会在项目默认的bin目录产生一个xml文件

3.替换以下中间件代码

builder.Services.AddSwaggerGen(option =>
{
    {   //xml文档的绝对路径
        var file = Path.Combine(AppContext.BaseDirectory, "WebApplication2.xml");
        //true显示 控制器注释
        option.IncludeXmlComments(file,true);
        //排序
        option.OrderActionsBy (o=>o.RelativePath);
    }
});

4.在接口前添加以下注释

  ///<summary>
         ///获取天气
         ///</summary>
         ///<returns></returns>

最后编译

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

得想办法娶到那个女人

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值