ServiceStackでServicestackを文書化する方法swagger-api（1.2）

Question

ServiceStack Webサービスの文書化にはswagger uiを使用しています。しかし、私はそれらの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... 
    } 

は、私はそれらのウェブサービスを使用するために不可欠であるドキュメント（威張っ-UI）の各プロパティの短い説明を必要とします。

私はServiceStack 3.9.74を使用していますが、これは最新のServiceStackバージョンにも当てはまります。そうでない場合は、私に知らせてください。

この情報をどうやって得るか、あるいはそうでない場合、私のWebサービスで作業しなければならない開発者にこのような重要な情報を提供する方法を知りました。私はServiceStackの環境で動作する他のアプローチやベストプラクティスも公開しています。

Answer 1

あなたのServiceStackのバージョンについてはわかりません。最新のバージョンでは、IReturn<ReturnClassHere>にあなたの要求があります。これは、返されたクラスを見てくれるように言います。

だからあなたのこのCustomerDataクラスには、次のようになります。

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

それはおそらく代わりに返されますあなたの応答のために別のDTOをセットアップする方が良いだろうが、

。たぶん CustomerDataResponseのようなものでしょう。