ASP.NET Core Web Api 自动帮助页面

Posted 2023-03-09

技术标签:

【中文标题】ASP.NET Core Web Api 自动帮助页面【英文标题】：ASP.NET Core Web Api automatic help pages 【发布时间】：2016-12-08 00:28:55 【问题描述】：

在以前的 ASP.NET 版本中，当我创建 Web Api 2 时，Visual Studio 自动为 API 自动生成文档。

这里也有解释： http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

我正在编写一个新项目，并决定使用 ASP.NET Core 来完成，但我没有看到任何类似于以前版本中存在的从 API 生成文档的内容（我是也猜测这有点不同，因为所有控制器现在都继承自同一个 Controller 类）。

但是，有没有办法为 ASP.NET Core API 生成帮助文件？

【问题讨论】：

【参考方案1】：

你想要的功能在https://github.com/domaindrivendev/Swashbuckle

以下链接提供了如何配置和使用精心设计的实用程序的示例 https://damienbod.com/2015/12/13/asp-net-5-mvc-6-api-documentation-using-swagger/

【讨论】：

【参考方案2】：

John Davidson 发表了一篇很好的文章，展示了如何生成 Swagger 文档 - 这很有用而且很棒。

但如果您想坚持使用 ASP.Net MVC 5 - Api Explorer 文档， 您应该看看那篇优秀的博文：

https://andrewlock.net/introduction-to-the-apiexplorer-in-asp-net-core/

【讨论】：

以上是关于ASP.NET Core Web Api 自动帮助页面的主要内容，如果未能解决你的问题，请参考以下文章