c# - 为 ASP.net WebAPI 自动生成文档

Question

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

1.) The url of the page/endpoint

2.) Description of what endpoint/page does

3.) List of arguments with descriptions and datatypes.

4.) HTTP Verb (get, post, put, delete)

5.) The permissions required for the page

必须手动编写描述。

我读过很多其他文章，这些文章导致个人使用 Swagger 等第三方应用程序。 ASP.Net 是否有内置的东西来帮助解决这个问题？如果我想尝试自己生成文档(不使用第 3 方软件)，我将如何开始创建此类文档？

我花了相当多的时间在谷歌上搜索各种问题，但似乎找不到答案。

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

Answer 1

作为 Swagger 的替代品，您可以使用 'Help Pages'用于 ASP.NET Web API。

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

• 相对 URI

• HTTP 方法

• 示例请求/响应数据

• API 用途的描述(源自 XML 注释)

如果可以使用第三方组件，那么我建议您使用Swagger (使用 Swashbuckle NuGet package )实现 API 文档。