c# - 如何在 ServiceStack 中启用 swagger？

Question

我发现在介绍性幻灯片中提到了招摇。但没有别的地方。是不是事情还没有完成？

编辑：显然它在待办事项列表中。

有什么好方法可以自动记录 RestAPI 吗？

Answer 1

要为您的服务堆栈启用 Swagger，请关注服务堆栈 wiki 上的Swagger API页面。

详细步骤：

1. Install-Package ServiceStack.Api.Swagger在包管理器控制台中运行。

2. 在您的 AppHost.cs 中启用 Swagger 插件：

   using ServiceStack.Api.Swagger;
   
   public override void Configure(Container container)
   {
     ...
     Plugins.Add(new SwaggerFeature());
     ...
   }
   

3. 使用 Swagger UI 访问http://localhost:port/swagger-ui/index.html

Answer 2

根据Trello的说法，这是一个“正在做”，但后来又被移回“待做”；并且在 github repo 中有一个 Swagger.Api 模块，所以假设它只是部分完成。

编辑

正如已经指出的那样（但为了完整起见，因为这是公认的答案），SwaggerUI 已准备好用于服务堆栈（天哪，它太棒了）。Github wiki已经在最近几天填写完毕，启动和运行非常容易。

Answer 3

看起来它现在已经完成并准备好了，请查看 v3.9.35 的发行说明 @ https://github.com/ServiceStack/ServiceStack/wiki/Release-Notes

Answer 4

嗯......对不起，如果我误解了这一点：

有什么好方法可以自动记录 RestAPI 吗？

...但是当我用以下属性装饰我的 DTO 或服务时：

[Route("/hello","GET")]
[Route("/hello/{Name}","POST,GET")]
public class Hello : IReturn<HelloResponse>
{
    public string Name { get; set; }
}

servicestack 生成的默认元数据页面记录了使用情况：

这不是你要找的吗？

Answer 5

对于.Net Core ServiceStack，所以我为 Swagger UI 安装了 ServiceStack.Api.Swagger.Core nuget。

但这给了我“500：未定义的错误”。

然后我删除了 ServiceStack.Api.Swagger.Core 并安装了 ServiceStack.Api.Swagger。

这是完美的作品。