WEBAPI 自动生成帮助文档

需求来源

WEBAPI开发过程中发现一个蛋疼的问题,给其他人员使用的时候还得整理文档,而API函数本身是有注释的,于是想到可以利用注释生成API帮助文档。

生成文档方法

1、安装Microsoft.AspNet.WebApi.HelpPage

Install-Package Microsoft.AspNet.WebApi.HelpPage

2、选中项目,右键,属性,生成,选择下面的XML 文档文件,目录自己填写,如下图:

3、找到 Areas/HelpPage/App_Start 目录下的HelpPageConfig.cs 文件,Register 方法,添加一行代码:

 config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/Areas/HelpPage/WebApiHelp.XML")));

4、重新生成然后访问即可

http://xxx.com/Help

 

posted @   哆啦无梦  阅读(285)  评论(0编辑  收藏  举报
编辑推荐:
· 智能桌面机器人:用.NET IoT库控制舵机并多方法播放表情
· Linux glibc自带哈希表的用例及性能测试
· 深入理解 Mybatis 分库分表执行原理
· 如何打造一个高并发系统?
· .NET Core GC压缩(compact_phase)底层原理浅谈
阅读排行:
· 手把手教你在本地部署DeepSeek R1,搭建web-ui ,建议收藏!
· 新年开篇:在本地部署DeepSeek大模型实现联网增强的AI应用
· Janus Pro:DeepSeek 开源革新,多模态 AI 的未来
· 互联网不景气了那就玩玩嵌入式吧,用纯.NET开发并制作一个智能桌面机器人(三):用.NET IoT库
· 【非技术】说说2024年我都干了些啥
点击右上角即可分享
微信分享提示