这篇文章主要介绍了在WEB api程序中如何使用swagger做接口文档,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。创建Web API程序在VS2019中创建一个asp.n
这篇文章主要介绍了在WEB api程序中如何使用swagger做接口文档,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。
在VS2019中创建一个asp.net Web应用程序,选择Web API来创建RESTful的Http服务项目,构选mvc和Web API核心引用。
使用NuGet包管理器,查找安装Swashbuckle,也就是Swagger插件。
在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);}
维护好controller路径中各个控制器接口方法的summary注释。
在API项目的生成设置里,构选生成XML文档文件。
编译、运行程序,在打开的Web地址后加上swagger,可以看到自动生成的接口文档和summary信息,可对接口进行测试。
感谢你能够认真阅读完这篇文章,希望小编分享的“在Web API程序中如何使用Swagger做接口文档”这篇文章对大家有帮助,同时也希望大家多多支持编程网,关注编程网精选频道,更多相关知识等着你来学习!
--结束END--
本文标题: 在Web API程序中如何使用Swagger做接口文档
本文链接: https://www.lsjlt.com/news/233855.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑,方便收藏和打印~
2024-05-16
2024-05-16
2024-05-16
2024-05-16
2024-05-16
2024-05-16
2024-05-16
2024-05-16
2024-05-16
2024-05-16
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
0