は、私は春ブーツRestControllerこのようになりますで、残りのメソッドのメソッドシグネチャを持って闊歩

Question

でリクエストパラメータのサンプル値を提供しますmessageパラメータはJSON文字列です（例：{"key" : "value"}）。誰もSwaggerアノテーションを使用してこれを行う方法を知っていますか？試しました

@ApiImplicitParams({ 
     @ApiImplicitParam(
       // ... 
       example = "...JSON value..." 
     ) 
}) 

しかし、動作しませんでした。私が望むのは、ドキュメントの "サンプル値"です。読者がクリックすると、ドキュメントのパラメータ値フィールドにサンプル値が入力されます。これは可能ですか？ここで

は、それがどのように見えるかもしれない方法のスクリーンショットです：

ただ、「役に立たない」の回答を予防します：私は私のビジネスのためにいくつかのクラス型にStringからパラメータの種類を変更することはできません論理。

Answer 1

アトミックなparametera（String、Number、...）のサンプル値またはサンプル値を提供することはできません。

あなたが唯一のパラメータは、スキーマを持つオブジェクトである場合、あなただけのプロパティの説明にexampleプロパティを追加する必要がある例を提供することができます：あなたは例の値を追加することができます最後の手段として

properties: 
    firstName: 
    description: first name 
    type: string 
    example: John 

をパラメータの説明（、ApiImplicitParam注釈）。

@ApiImplicitParam(
      name = "message", 
      value = "Message that is sent to the method. Example: value", 
      required = true, 
      dataType = "string", 
      paramType = "body" 
    )