C#在WEBAPI中配置Swagger

        在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);
        }

扫描二维码关注公众号，回复： 10313772 查看本文章

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

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

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

在API项目生成里，勾选生成XML文档文件，保存：

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

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

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