2013-01-24 121 views
6

ServiceStack.Api.Swagger v3.9.33是否可能使用Swagger來描述API操作的響應和返回的狀態代碼?也許通過在Response類/屬性屬性裝飾等如何使用Swagger/ServiceStack指定響應類別並返回狀態代碼

從寵物商店API用於下面的示例操作中的突出顯示的部分一樣: (http://petstore.swagger.wordnik.com/

enter image description here

我只能看到HTTP方法和請求DTOS可以在https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API上進行修飾,並且快速瀏覽代碼看起來可能尚不支持,https://github.com/ServiceStack/ServiceStack/tree/master/src/ServiceStack.Api.Swagger

回答

3

截至目前,如果您拉動ServiceStack倉庫的頭部,這是可能的。我剛剛得到了一個合併的pull請求,它添加了用[ApiResponse]屬性修飾請求DTO的選項。看到這裏的細節:

https://github.com/ServiceStack/ServiceStack/issues/590#issuecomment-17575292

+0

不幸的是,問題是消失:(我有ApiResponse屬性,但只是添加StatusCodes。當我檢查JSON的ResponseClass模型是存在,但沒有屬性,即使我有它歸因於Api&ApiMember – unreal

1

我正在尋找解決同一問題的方法。

我來的發現,它目前尚未實現 - >參見:https://github.com/ServiceStack/ServiceStack/blob/master/src/ServiceStack.Api.Swagger/SwaggerApiService.cs舉證

因此,目前還沒有整合的響應模式或狀態代碼。

+0

是的,我認爲在幾個月沒有迴音意味着沒有進步呢,希望在路線圖上。乾杯。 –

+0

如果你有一些閒暇時間,我簡單地看看它: 示例:http://petstore.swagger.wordnik.com/api/api-docs.json/pet 文檔:https://github.com/ wordnik/swagger-core/wiki/Resource-Listing 我建議:遍歷所有響應類(以與服務棧對請求執行的相同方式)並掃描屬性(您將必須指定它們) - >但這部分是爲了我的c#/。淨知識 –

+0

很多對應的github-ticket:https://github.com/ServiceStack/ServiceStack/issues/590 –

2

試着讓你的請求(其中已應用RouteAttribute)來實現ServiceStack.ServiceHost.IReturn<TResponseType>其中TResponseType是你的反應類型。

所以例子應該是這個樣子:

[Route("/todos")] 
[Route("/todos/{Ids}")] 
public class Todos : IReturn<List<Todo>> 

IReturn<List<Todo>>是你在找什麼