在ASP .NET Core 2.0中自我记录REST服务

时间:2018-01-09 23:13:37

标签: c# .net rest swagger asp.net-core-2.0

我想为我们的服务提供的REST API发布REST元数据。 ASP.Net在过去几年中已经改变了很多次,我无法获得有关推荐做法的任何有用信息。不断出现的名字是Swagger。 我猜这是现在推荐的框架。这是一个安全的假设吗?

但是,为了使用Swagger,我们需要使用支持ASP.NET Core 2.0的开源库。看起来Swagger支持内置于ASP.NET Core 2.0中并不存在。我认为Microsoft必须为REST服务提供某种标准的开箱即用自我文档,但我无法在其上找到任何文档。 ASP.NET Core 2.0中是否内置了自助记录REST服务的内容? 如果是这样, 是否值得尝试实现它而不是Swagger ?或者,Swagger是优秀的吗?

ASP.NET Core 2.0是否有事实上标准的.NET Swagger库 ?这篇文章似乎推荐Swashbuckle。 Swashbuckle是一个安全的赌注吗?

https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio

1 个答案:

答案 0 :(得分:4)

ASP.NET Core 2.0没有内置的API文档生成器。 Swagger是您可能会发现的最常见(可能是最好的)API文档框架。 Swashbuckle不是Swagger的替代品,而是一种从您编写到代码中的XML文档中生成与swagger兼容的元数据的机制。

Here's你可能想要开始。