在WebAPI程序中如何使用Swagger做接口文档-创新互联

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

创新互联是一家业务范围包括IDC托管业务,网络空间、主机租用、主机托管，四川、重庆、广东电信服务器租用,成都托管服务器，成都网通服务器托管,成都服务器租用,业务范围遍及中国大陆、港澳台以及欧美等多个国家及地区的互联网数据服务公司。

创建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://mswzjz.cn/article/dpieed.html