【无标题】

       在C#中,开发WEBAPI很多时候需要前后端联调,这其中就涉及到接口文档,而Swagger可以直接把接口文档在代码里生成出来,当然,你的代码的注释一定要写全。

      首先创建一个WebAPi,此处就不多阐述了,基本操作:

然后在添加Nugget包:

在APP_START里找到SwaggerConfig,

在SwaggerConfig里增加配置:大概在108行左右,

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
在SwaggerConfig里最后面增加方法GetXmlCommentsPath

protected static string GetXmlCommentsPath(string name)
        {
            return System.String.Format(@"{0}\bin\{1}.xml", System.AppDomain.CurrentDomain.BaseDirectory, name);
        }


 

然后APIConfig里的routeTemplate下增加 /{action}/:

routeTemplate: "api/{controller}/{action}/{id}"


至此,配置就完成了。在你的项目里,配置继承了Apicontroller下,维护好<summary>,即可。

在API项目生成里,勾选生成XML文档文件,保存:

查看效果为你的网址后面加上swagger:

这里都可以看到写在<summary>的注释。

最后,提醒一点:controller要继承Apicontroller,同一controller不可有两个同名的方法,比如Get(),Get(int id).会报错。可通过配置Route解决。这里我就不多阐述了。

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

山林恩泽

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

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

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

打赏作者

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

抵扣说明:

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

余额充值