Question

我正在使用swagger ui来获取我的ServiceStack Web服务的文档。但是我没有找到添加任何有关这些Web服务（json）响应的信息的方法。因此，当我的服务的GET方法如下所示：

    public object Get(CustomerData customers)
    {
         List<CustomerDAO> customers = DataProvider.GetAllCustomers();
         return customers;
    }


 public class CustomerDAO
 {
     // this is important information which needs to be visible in swagger-ui
    public string Name { get; set; }
    public string SomeImportantProperty { get; set; }    
    public string AnotherPropery { get; set; }
    public string AlsoWorthDocumenting { get; set; }
    // and so on...
  }

我需要文档（swagger-ui）中每个属性的简短描述，这对于使用这些Web服务至关重要。

我正在使用ServiceStack 3.9.74，但这也适用于最新的ServiceStack版本。如果没有，请告诉我。

我想知道如何能够获得这些信息，或者如果没有，如何向必须使用我的Web服务的开发人员提供这些重要信息。我也对在ServiceStack环境中工作的任何其他方法或最佳实践持开放态度。

Answer 1

我不确定您的ServiceStack版本。在最新版本中，你会得到你的请求d IReturn<ReturnClassHere>，这将告诉招摇的人看看那个返回类。

所以你的CustomerData类看起来像这样：

public class CustomerData : IReturn<List<CustomerDAO>>
{
}

虽然为您的响应设置另一个dto可能会更好，但是会返回。也许像CustomerDataResponse。

ServiceStack中的文档服务响应如何使用Servicestack swagger-api（1.2）

1 个答案: