@ExampleProperty/value is getting ignored

[napolev]

What version of the library are you using?

2.9.2

What kind of issue is this?

Bug

Example Repository

https://github.com/napolev/springfox-swagger2-issue

How to recreate the issue

$ git clone https://github.com/napolev/springfox-swagger2-issue
$ cd springfox-swagger2-issue
$ gradle bootRun

Description of the issue

On the repository pointed above there is a very simple project which contains the following file:

/src/main/java/com/example/demo/car/CarController.java

The issue is that the @ExampleProperty / value is getting ignored as you can see on the image below:

Other than that, everything works fine. For example, for the following payload the response is correct:

[ironijunior]

+1

[charlycou]

+1

[trevarmand]

+1

[dilipkrish]

@napolev thank you for a detailed issue. I'll look into this issue. Can you see what the json looks like for the endpoint? Im curious if this is an issue with swagger-ui

[denbard]

+1

[Maegner]

@dilipkrish seems like a UI issue since the examples actually get to the FE but are never displayed.

[markewallace]

+1

[napolev]

Hi @dilipkrish, any update on this? Thanks!

[marciosindeaux]

+1

[shantis]

@dilipkrish Any update on this issue? The examples are not working in 2.9.2. For us examples are a must for documentation. Please help!

[tlg-265]

is this project discontinued maybe?

[shantis]

So examples will never work in springfox -- I wonder how other organizations used swagger with examples in 2.0. Any pointers would really help. Thanks!

[tobHai]

Like @Maegner said the x-examples are loaded properly however they are not displayed in the UI.
Any hints on how to solve this ?
As far as I understand the index.html in swagger-ui folder loads a certain webjar version of the UI but how can a change be made to this webjar?
Is it possible to load another version of the webjar?

[vemonet]

Apparently x-examples are already a workaround for POST queries:
swagger-api/swagger-ui#1980

I did not have issue using examples for post queries with OAS3 (which should be normal, I don't see why we should use a different property label for POST queries) resolved by https://smart-api.info/

[nikosvaggalis]

I discovered that springfox produces x-examples in the json description file which is not recognized by spring-ui.The right format that spring ui correctly renders is having the example as part of the schema block of the field.Also called example not x-examples

"schema":{ "type":"string", "example" : { "property":"this is a test" }}

all libraries versions are 2.9.2.
Can someone please verify?
thanks

[mdfass]

Has anybody tried this with 3.0.0.-SNAPSHOT? I have the same issue with 2.9.2

[indicasta]

Hi! @mdfass I already tried with 3.0.0-SNAPSHOT and still the same issue with 2.9.2. No change about it!

[nikosvaggalis]

yes,I've tried with 3.0.0-SNAPSHOT and it's still the same.Can you try to do what I've suggested to see if it works for you?

[indicasta]

Hi! @nikosvaggalis I have tried what you suggested before about changing the JSON file produced by Springfox , replacing the "x-examples" by:

"schema":{ "type":"string", "example" : { "property":"this is a test" }}

For this purpose I took the first example in this issue provided by @napolev, first of all I changed the Springfox version from 2.9.2 to 3.0.0-SNAPSHOT and reduced the JSON file obtained with this last version, then I converted the JSON file to YML using the swagger editor. You can find the result in https://github.com/indicasta/springfox-swagger2-issue/blob/master/api-docs-reduced.yml. Finally with this reduction I got the expected result shown in the image below.

Do you have any idea on how can I get that result by using Springfox automatically?

Just in case here you have the repo I created for this purpose:

https://github.com/indicasta/springfox-swagger2-issue

Thanks!

[tlg-265]

thank you @indicasta for your clear feedback. I think we need to know what Springfox annotations to use on top of the controller method in order to let Springfox to do the proper conversion from Java to Swagger syntax (left panel on the image above). In my opinion this is a very common use case. Hopefully @dilipkrish can provide some light on this.

[napolev]

Bingo! Finally on this commit I was able to find the way to make Sprinfox Swagger to auto populate the values on the Swagger UI:

napolev/springfox-swagger2-issue@7e2591d

Here you have a screenshot of it:

Thank you guys for all your help including @indicasta.

[prabhushrikant]

Has anybody tried this with 3.0.0.-SNAPSHOT? I have the same issue with 2.9.2

I tried with 3.0.0-SNAPSHOT and issue still persists

[prabhushrikant]

Hi! @nikosvaggalis I have tried what you suggested before about changing the JSON file produced by Springfox , replacing the "x-examples" by:

"schema":{ "type":"string", "example" : { "property":"this is a test" }}

For this purpose I took the first example in this issue provided by @napolev, first of all I changed the Springfox version from 2.9.2 to 3.0.0-SNAPSHOT and reduced the JSON file obtained with this last version, then I converted the JSON file to YML using the swagger editor. You can find the result in https://github.com/indicasta/springfox-swagger2-issue/blob/master/api-docs-reduced.yml. Finally with this reduction I got the expected result shown in the image below.

Do you have any idea on how can I get that result by using Springfox automatically?

Just in case here you have the repo I created for this purpose:

https://github.com/indicasta/springfox-swagger2-issue

Thanks!

I confirm it works in editor.swagger.io if you manual add example section but springfox simply ignores it if it finds a reference model and tries to infer the schema from model. However this approach doesn't work if your model going to have dynamic property names e.g. model has <string, object> response property.

[dilipkrish]

This has be fixed via #2767