自动为ASP.net WebAPI生成文档

Question

我目前在ASP.Net中有一个使用WebApi的MVC项目。 控制器的大部分代码都是用c＃编写的。 我想自动生成API调用的描述，包括：

1.）页面/端点的URL

2.）端点/页面的描述

3.）包含描述和数据类型的参数列表。

4.）HTTP动词（获取，发布，放置，删除）

5.）页面所需的权限

必须手动编写说明。

我已经阅读了很多其他文章，导致个人使用像Swagger这样的第三方应用程序。 是否内置了ASP.Net的内容来帮助解决这个问题？ 如果我想尝试自己生成文档（不使用第三方软件），我将如何开始创建此类文档？

我花了相当多的时间在谷歌搜索各种查询，似乎无法找到答案。

编辑：在我的案例中使用Swagger而不是ASP.Net帮助页面有什么好处？

Answer 1

作为Swagger的替代方案，您可以使用ASP.NET Web API的“帮助页面” 。

本文档中的条目是自动生成的，包含以下信息：

• 相对URI

• HTTP方法

• 样本请求/响应数据

• API目的的描述（源自XML注释）

如果可以使用第三方组件，那么我建议您使用Swagger （使用Swashbuckle NuGet包 ）来实现API文档。

Answer 2

Swagger不只是列出你的api uris。 用户实际上尝试了它们并看到响应

Swagger具有在实现文档之前创建文档的工具。

它还可以使用注释添加说明。