在WebAPI程序中如何使用Swagger做接口文档

这篇文章主要介绍了在Web API程序中如何使用Swagger做接口文档，具有一定借鉴价值，感兴趣的朋友可以参考下，希望大家阅读完这篇文章之后大有收获，下面让小编带着大家一起了解一下。

目前创新互联已为成百上千家的企业提供了网站建设、域名、网络空间、成都网站托管、企业网站设计、满洲网站维护等服务，公司将坚持客户导向、应用为本的策略，正道将秉承"和谐、参与、激情"的文化，与客户和合作伙伴齐心协力一起成长，共同发展。

创建Web API程序

在VS2019中创建一个ASP.NET Web应用程序，选择Web API来创建RESTful的HTTP服务项目，构选MVC和Web API核心引用。

安装Swashbuckle

使用NuGet包管理器，查找安装Swashbuckle，也就是Swagger插件。

配置SwaggerConfig

在APP_START里找到SwaggerConfig，大概在105行左右有对c.IncludeXmlComments的注释，在此处添加配置：

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

在SwaggerConfig的最后，给类添加方法：

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

维护接口方法的Summary

维护好controller路径中各个控制器接口方法的summary注释。

生成项目的XML文档文件

在API项目的生成设置里，构选生成XML文档文件。

编译并运行程序

编译、运行程序，在打开的Web地址后加上swagger，可以看到自动生成的接口文档和summary信息，可对接口进行测试。

感谢你能够认真阅读完这篇文章，希望小编分享的“在Web API程序中如何使用Swagger做接口文档”这篇文章对大家有帮助，同时也希望大家多多支持创新互联，关注创新互联行业资讯频道，更多相关知识等着你来学习!

网页名称：在WebAPI程序中如何使用Swagger做接口文档
URL网址：http://shouzuofang.com/article/jigppe.html