ServiceStack & Swagger - ApiMember 作为路径和查询

Question

我正在寻找有关 ServiceStack 中 Swagger 集成的以下问题的解决方案。

我的 RequestObject 具有必需的属性 ID。
我想提供以下路线:

[Route("/User/byId/{Id}", "GET", Summary = @"test", Notes = "test")]
[Route("/User/byId", "GET", Summary = @"test", Notes = "test")]

基本上这应该留下在查询字符串中提供 Id 或作为 ServiceConsumer 的路径的选择。

Swagger UI 正确显示了 2 条路由，但无法对两种方式进行测试，因为 API-Member 属性不允许将其指定为 ParameterType 'path' 或 'query'。

来源: https://gist.github.com/JohannesFerner/5317496

有什么方法可以提供 API-Member 规范，特别是针对相应的 Route，或者将其定义为 Path 和 Query 有效？

像这样:

[ApiMember(Name = "Id", ParameterType="path,query", Description = "User Id",  DataType = "int", IsRequired = true)]

Answer 1

在这种情况下，我发现创建两个单独的 DTO 类来帮助在 Swagger 中正确记录每条路线是最容易的。 DTO 类可能具有相同的属性(在本例中为 Id，看起来像)，以及不同的 Route和 ApiMember属性。您将有两个服务方法，每个 DTO 一个，它们可以调用共享方法，传入 Id 的值。属性，因此大部分实现不会重复。