2016-07-26 5 views
0

Swaggerを使用してREST APIを文書化しています。Swagger:クラスのプロパティをパラメータの値の値から削除します

私はこのようなクラスを持っています:

public class Source{ 
    private String url; 
    private String category; 
    private String label; 
    ... 
} 

私は現在Source.classにデータ型を設定する@ApiImplicitParamを使用していますが、私はと身体パラメータとしてJSONを取得し、複数のPOSTリクエストを持っています例えば、これらの単一の変数を言うことができます:

{"label": "labelA"} 

ため、以前に設定のデータ型の、闊歩UIで表示される値の例は次のようなもの、全体Source.classです

{ 
    "url": "string", 
    "category": "string", 
    "label": "string", 
    ... 
} 

スワッガーUIが表示するサンプル値を、その1回のリクエストごとに何とか切り詰めることはできますか?つまり、getSourceFromUrl()リクエストでは、urlフィールドのみを含むJSONを取得する必要があります。この例では、完全なSource.class JSONではなく、正確にこの例を表示する必要があります。

ありがとうございました!

UPDATE

私はJAX-RSを使用しています。必要に応じて入力をお願いします。

+0

[闊歩応答からモデルまたはプロパティを除外](https://stackoverflow.com/questions/27777537/exclude-models-or-properties-from-の可能な重複swagger-response) – Helen

答えて

0

springfox-swagger2を使用している場合は、これを行う注釈@ApiModelPropertyがあります。

例:

@ApiModelProperty(required = false, hidden = true) 
private String label; 
+0

ありがとうございました。私の問題は、私は複数のエンドポイントを持っているので、すべてのクラスのプロパティの異なるセットを使用して、パラメータの値として同じクラスを使用したいと考えています。 JAX-RSを使用しています(私の投稿を更新します)。 P.S .: @ApiModelPropertyはクラス内で使用でき、このクラスをサンプル値として使用するすべてのエンドポイントに影響を与えます。私が間違っている? – cr1ng3

関連する問題