微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

c# – 我应该如何为我的Web服务API生成文档?

我通过Web服务(.asmx)公开我的API.目前,唯一可用的是认的WSDL帮助页面.虽然这非常有帮助,但如果我的目标受众需要更多的手持,这还不够.例如,让我们说我想要包含一些示例,但仍需要自动生成方法签名等.

是否有良好的半自动化(自动方法签名,但仍能提供示例)来实现这一目标?我正在寻找像this这样的东西,它也是可维护的.理想情况下,帮助我修改认WSDL(我真的很喜欢那个页面)会很棒.我所需要的只是在部署文档时自动提供文档.

有什么建议?

解决方法

也许最简单的方法是使用XML文档注释.

XML Documentation Comments

使用这些注释,您可以自动生成HTML文档.例如,使用SandcastleNDoc3

Build Sandcastle Documentation When Building Visual Studio Project

毕竟,您可以自动将html文档保存到服务附近的共享位置,并且可以使用浏览器轻松导航到该位置.所以,所有可能都接近 – wsdl html文档

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐