在以前版本的 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 生成帮助文件?
您想要的功能位于 https://github.com/domaindrivendev/Swashbuckle
以下链接提供了如何配置和使用精心设计的实用程序的示例 https://damienbod.com/2015/12/13/asp-net-5-mvc-6-api-documentation-using-swagger/
John Davidson 发表了一篇很好的文章,展示了如何生成 Swagger 文档 - 这非常有用且很棒。
但是如果您想坚持使用 ASP.Net MVC 5 - Api Explorer 文档,您应该看看这篇优秀的博客文章:
https://andrewlock.net/introduction-to-the-apiexplorer-in-asp-net-core/
对于此实例,我使用 Microsoft.AspNetCore.Mvc.ApiExplorer 注入 IApiDescriptionGroupCollectionProvider,并尝试为 IApiDescriptionProvider、DefaultApiDescriptionProvider 添加枚举
然后我创建了一个帮助控制器,它为我提供了一个循环到 ApiDescriptionGroups.Items[0] 的字符串列表,然后获取每个相对路径。还检查是否有 ParameterDescriptions,然后将其所有名称传递给 stringbuilder 以向我提供 API 描述。不错,但是呵呵。这就是老头要我做的事。哈哈哈