2013-01-24 6 views
6

ServiceStack.Api.Swagger v3.9.33では、Swaggerを使用してAPI操作と返されたステータスコードの応答を記述できますか?おそらく、レスポンスクラス/プロパティの属性の装飾などによりペットショップのAPIから次の例の操作のための強調表示セクションと同様にResponseクラスを指定してスワッガー/ ServiceStackを使用してステータスコードを返す方法

: (http://petstore.swagger.wordnik.com/

enter image description here

私は見ることができますHTTPメソッドとRequest DTOSはhttps://github.com/ServiceStack/ServiceStack/wiki/Swagger-APIに装飾でき、コードはまだサポートされていない可能性があります。https://github.com/ServiceStack/ServiceStack/tree/master/src/ServiceStack.Api.Swagger

答えて

3

今のところ、ServiceStackレポの頭を引っ張ると可能です。私はちょうどあなたの要求DTOを[ApiResponse]属性で装飾するオプションを追加するプルリクエストをマージしました。詳細はこちらをご覧ください:

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 docs:https://github.com/ (サービススタックが要求と同じ方法で)すべての応答クラスをウォークし、属性をスキャンする(指定する必要があります) - >しかし、その部分は、私のC#/。ネット知識のために多くのものです –

+0

対応するgithubチケット:https://github.com/ServiceStack/ServiceStack/issues/590 –

2

はTResponseTypeがあなたの応答タイプですServiceStack.ServiceHost.IReturn<TResponseType>を実装するために(あなたがRouteAttributeを適用している)あなたの要求を行うようにしてください。

ですから、例えばのようなものになります。

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

IReturn<List<Todo>>はあなたが