I am creating a REST Api using Spring boot, and auto generating the swagger documentation in controllers using swagger codegen. However, I am not able to set a description and example for a parameter of type String in a POST request. Here is mi code:
    
    import io.swagger.annotations.*;
    
    @Api(value = &quot;transaction&quot;, tags = {&quot;transaction&quot;})
    @FunctionalInterface
    public interface ITransactionsApi {
        @ApiOperation(value = &quot;Places a new transaction on the system.&quot;, notes = &quot;Creates a new transaction in the system. See the schema of the Transaction parameter for more information &quot;, tags={ &quot;transaction&quot;, })
        @ApiResponses(value = {
            @ApiResponse(code = 200, message = &quot;Another transaction with the same messageId already exists in the system. No transaction was created.&quot;),
            @ApiResponse(code = 201, message = &quot;The transaction has been correctly created in the system&quot;),
            @ApiResponse(code = 400, message = &quot;The transaction schema is invalid and therefore the transaction has not been created.&quot;, response = String.class),
            @ApiResponse(code = 415, message = &quot;The content type is unsupported&quot;),
            @ApiResponse(code = 500, message = &quot;An unexpected error has occurred. The error has been logged and is being investigated.&quot;) })
    
        @RequestMapping(value = &quot;/transaction&quot;,
            produces = { &quot;text/plain&quot; },
            consumes = { &quot;application/json&quot; },
            method = RequestMethod.POST)
        ResponseEntity&lt;Void&gt; createTransaction(
            @ApiParam(
                value = &quot;A JSON value representing a transaction. An example of the expected schema can be found down here. The fields marked with an * means that they are required.&quot; ,
                example = &quot;{foo: whatever, bar: whatever2}&quot;)
            @Valid @RequestBody String kambiTransaction) throws InvalidTransactionException;
    }

**The example property of the @ApiParam has been manually inserted by me, because the codegen was ignoring that part of the yaml (That is another question: why is the editor ignoring the example part?).** Here is part of the yaml:

    paths:
      /transaction:
        post:
          tags:
            - transaction
          summary: Place a new transaction on the system.
          description: &gt;
            Creates a new transaction in the system. See the schema of the Transaction parameter
            for more information
          operationId: createTransaction
          parameters:
            - $ref: &#39;#/parameters/transaction&#39;
          consumes:
            - application/json
          produces:
            - text/plain
          responses:
            &#39;200&#39;:
              description: Another transaction with the same messageId already exists in the system. No transaction was created.
            &#39;201&#39;:
              description: The transaction has been correctly created in the system
            &#39;400&#39;:
              description: The transaction schema is invalid and therefore the transaction has not been created.
              schema:
                type: string
                description: error message explaining why the request is a bad request.
            &#39;415&#39;:
              description: The content type is unsupported
            &#39;500&#39;:
              $ref: &#39;#/responses/Standard500ErrorResponse&#39;

    parameters:
      transaction:
        name: kambiTransaction
        in: body
        required: true
        description: A JSON value representing a kambi transaction. An example of the expected schema can be found down here. The fields marked with an * means that they are required.
        schema:
          type: string
          example:
            {
              foo*: whatever,
              bar: whatever2
            }

And finally, this is what swagger is showing:

[![enter image description here][1]][1]

Finally, the dependencies used in build.gradle are the following ones:

    compile group: &#39;io.springfox&#39;, name: &#39;springfox-swagger2&#39;, version: &#39;2.7.0&#39;
    compile group: &#39;io.springfox&#39;, name: &#39;springfox-swagger-ui&#39;, version: &#39;2.7.0&#39;

**So, Question is:**
Does anybody know how I can set the description and an example of a body parameter using swagger annotations?

***EDIT***

I&#39;ve achieved to change the description using @ApiImplicitParam instead of @ApiParam, but example is still missing:

    @ApiImplicitParams({
        @ApiImplicitParam(
            name = &quot;kambiTransaction&quot;,
            value = &quot;A JSON value representing a transaction. An example of the expected schema can be found down here. The fields marked with * means that they are required. See the schema of KambiTransaction for more information.&quot;,
            required = true,
            dataType = &quot;String&quot;,
            paramType = &quot;body&quot;,
            examples = @Example(value = {@ExampleProperty(mediaType = &quot;application/json&quot;, value = &quot;{foo: whatever, bar: whatever2}&quot;)}))})


  [1]: https://i.stack.imgur.com/uw5ZU.png

All Swagger Codegen Solutions on Gang of Coders

Total of 1 Swagger Codegen Solutions

How can I set a description and an example in Swagger with Swagger annotations?