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

时间:2016-08-02 15:00:39

标签: asp.net asp.net-core asp.net-core-mvc asp.net-core-1.0 asp.net-core-webapi

在以前的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生成帮助文件?

2 个答案:

答案 0 :(得分:2)

您想要的功能是https://github.com/domaindrivendev/Swashbuckle

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

答案 1 :(得分:0)

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

但是,如果你想坚持 ASP.Net MVC 5 - Api Explorer文档,,你应该看看那篇优秀的博客文章:

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