如何正确使用ServiceStack中的Api属性来命名SwaggerUI中的服务?
问题描述:
使用Swagger-UI和ServiceStack,我试图使用Api
属性来命名我的服务更清洁。如何正确使用ServiceStack中的Api属性来命名SwaggerUI中的服务?
我很难找出属性需要添加description
属性到由swagger创建的resources
端点中的api。
我有一个基本请求被我的客户端点的其他一些请求继承。 Api
属性仅在放置在此特定请求dto时才起作用。如果我将它移动到另一个,它将停止工作。这里是什么我昂首阔步页面看起来像〔实施例:
下面是该代码:
,这里是似乎没有工作的代码:
我想有一个好记的名称为每个SERVIC即谢谢!
编辑:我确实追踪了ServiceStack代码库中的一些代码,表明它正在寻找FirstAttribute
。我试着通过改变事物的顺序来进行测试,但也没有得到理想的结果。如果有帮助,我正在寻找AttributeExtensions.cs。
答
您可以使用[Api("API Description")]
或[Description("API Description")]
的说明添加到一个服务虽然这并不总是直接多个路由映射到扬鞭路线描述为扬鞭UI组覆盖多个不同的单个顶级路线下共享顶级路线的服务。
但是你可以在SwaggerFeature
指定路由聚合与RouteSummary
字典,e.g:
Plugins.Add(new SwaggerFeature {
RouteSummary = {
{ "/top-level-path", "Route Summary" }
}
});
嗨mythz,是有道理的。你是否告诉我,没有办法直接设定招摇摆打会显示什么?如果我将其添加到特定路线的所有路线中,它会起作用吗?即以“/ marketing”开头的路线(我认为这是一个让人sw目结舌的路线)? – IronicMuffin
@IronicMuffin仅供参考我已经添加了一个使用SwaggerFeature上的RouteSummary功能来指定Route Summary说明的示例。 – mythz
谢谢 - 我没有意识到这是一个选项! – IronicMuffin