スワッガーUIのサンプルデータ

Question

スワッガーのサンプルデータを表示する方法はありますか。モデル、両方の入力&出力、クエリパラメータ、ヘッダーなど？私はこれに関連するものを注釈のドキュメントで見つけることができませんでした。あなたがウィキに言及した注釈のいくつかのドキュメントを見れば https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X

Answer 1

あなたは彼らがexampleまたはexamplesと呼ばれる彼らのオプションパラメータ1の間で持って表示されます。このパラメータを使用して、1つの例を追加することも、複数の例を追加することもできます（許可されている場合）。

クエリパラメータのたとえばあなたが@ApiParam注釈を使用して、このようにそれを行うことができます：返信用

@Path("/{username}") 
@ApiOperation(value = "Updated user") 
public Response updateUser(
    @ApiParam(example = "moondaisy") @QueryParam("username") String username 
) { 
... 
}