【发布时间】:2016-09-23 11:55:56
【问题描述】:
我正在寻找用于 asp.net web api 应用程序的文档工具或生成器。该工具必须允许编辑 API 方法或参数的描述/摘要。 我可能需要这个,以允许不同的团队说 PM、QA 也可以编辑文档,这样它就不必总是开发人员。
请推荐任何支持此要求的好工具。
【问题讨论】:
标签: asp.net-web-api asp.net-web-api-helppages
我正在寻找用于 asp.net web api 应用程序的文档工具或生成器。该工具必须允许编辑 API 方法或参数的描述/摘要。 我可能需要这个,以允许不同的团队说 PM、QA 也可以编辑文档,这样它就不必总是开发人员。
请推荐任何支持此要求的好工具。
【问题讨论】:
标签: asp.net-web-api asp.net-web-api-helppages
我们一直在使用 Swagger 来记录我们的 API。这个 Nuget 包 Swashbuckle 将 Swagger 添加到您的 api 项目中。 https://github.com/domaindrivendev/Swashbuckle
文档是使用 XML cmets 创建的,并显示在一个漂亮的 UI 界面中,您甚至可以从中测试您的 API。
【讨论】:
感谢您的回复。我同意你的看法。
现在,我正在寻找从我现有的 xml 文档生成的在线文档工具。 该在线文档可以由团队成员进一步编辑并发布。
【讨论】: