如何正确使用ServiceStack中的Api属性在SwaggerUI中命名服务?

时间:2016-11-14 13:31:00

标签: servicestack swagger-ui

使用Swagger-UI和ServiceStack,我尝试使用Api属性来更清楚地命名我的服务。

我很难弄清楚属性需要在哪里添加description属性到由swagger创建的resources端点中的api。

我有一个基本请求,由我的客户端点的一些其他请求继承。 Api属性仅在放置在此特定请求dto上时才有效。如果我把它移到另一个,它就会停止工作。这是我的招摇页面的例子:

enter image description here

以下是代码:

enter image description here

以下代码似乎不起作用:

enter image description here

我希望每个服务都有一个友好的名字。谢谢!

编辑:我确实在ServiceStack代码库中找到了一些代码,表明它正在寻找FirstAttribute。我尝试通过改变事物的顺序进行测试,但也没有得到预期的结果。如果有帮助,我正在查看AttributeExtensions.cs

1 个答案:

答案 0 :(得分:1)

您可以使用[Description("API Description")]RouteSummary 向单个服务添加描述虽然这并不总是直接映射到Swagger路由描述,因为Swagger UI在单个顶级路由下分组多个路由,这些路由覆盖共享顶层路由的多个不同服务。

但您可以在SwaggerFeature上使用Plugins.Add(new SwaggerFeature { RouteSummary = { { "/top-level-path", "Route Summary" } } }); 词典指定路线摘要,例如:

5>>test.txt