2013-05-06 54 views
2

上有可能有ApiMember屬性數據顯示在ServiceStack有關要求DTO複雜類型的屬性生成的元數據?如果是這樣,這怎麼能實現呢?如何顯示ApiMember屬性爲複雜類型的屬性數據ServiceStack的產生元數據頁

比方說,我有一個具有以下性質的請求DTO:

public Customer Customer { get; set; }   
public List<CustomerOrder> CustomerOrders { get; set; } 

和客戶類型具有以下屬性:

public string Id { get; set; }  
public string CompanyName { get; set; }  
public string ContactName { get; set; } 

我希望能夠添加ApiMember屬性到客戶的財產。但是,當我這樣做時,請求DTO的元數據頁面不顯示客戶的屬性。

我還想讓CustomerOrder的屬性也顯示在元數據頁面上。我意識到這可能會有點棘手,因爲它是CustomerOrder類型的列表。

如果這不被支持,歡迎其他選項的建議。

+0

你見過ServiceStack的Swagger支持嗎? https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API。我認爲這是處理文檔的一個非常好的方法。 – paaschpa 2013-05-06 18:30:36

+0

@paaschpa:我已經看到了它並且會嘗試它,但是想要讓基本元數據頁面按預期工作。如果Swagger API爲複雜類型的屬性選擇了ApiMember屬性,那麼這聽起來像是一個可接受的解決方案。任何人都可以確認Swagger API是否可以處理上面給出的場景?如果沒有人能確認,我會試一試並在時間允許後發佈更新。 – timb 2013-05-06 20:38:05

回答

2

我認爲您目前不支持您正在尋找的內容。我認爲ApiApiMember屬性意在跟隨/鏡像Swagger API and DataTypes。在Swagger API中,支持complex類型,但爲了獲取複雜類型的詳細信息,需要在API聲明的models部分中找到。我不認爲models目前在ServiceStack中處理。至少,我還沒有偶然發現它within the code

+1

沒錯,並不是所有的Swagger屬性都已經在元數據頁面中完成了它(歡迎使用pull-reqs!:) - 但是這是在我們的TODO列表中,所以應該很快就會提供。 – mythz 2013-05-06 22:32:10