Swagger UI, @ApiResponse doesn't give correct response as a examle value.

Question

I have implemented swagger UI in my application. Everything is working fine but the issue is, consider the situation in my API I have different request and response object, but both object's class is annotated with the same json root element name (Ex: @JsonRootName("user")).For this reason in my swagger UI it gives me same example value in Parameters body and in Responses body. If i remove this @JsonRootName tag from any one class than swagger UI shows me correct example value, but for my application i can't remove this annotation from any class and even can't change the value of it.I tried many option available on internet but can't resolve my problem. Please help me to resolve this. Please refer the attached screens.
&nbsp;
Thanks, Waiting for your response.

frantuma · Answer

In scenarios like the one described (multiple `JsonRootName` with same value, and `ApiModel` annotations applied, there's indeed a bug preventing `ApiModel` annotation to be considered first. This has been addressed in&nbsp;PR #3292&nbsp;, therefore in latest snapshot and from upcoming release `1.5.24` such scenario would result in the expected outcome.&nbsp; With eariler version the same can be achieved providing a custom converter extending `ModelResolver` and overriding `_findTypeName`:
class CustomSchemaNameResolverConverter extends ModelResolver {

public CustomSchemaNameResolverConverter(ObjectMapper mapper) {
            super(mapper);
        }

protected String _findTypeName(JavaType type, BeanDescription beanDesc) {
            // First, handle container types; they require recursion
            if (type.isArrayType()) {
                return "Array";
            }

if (type.isMapLikeType()) {
                return "Map";
            }

if (type.isContainerType()) {
                if (Set.class.isAssignableFrom(type.getRawClass())) {
                    return "Set";
                }
                return "List";
            }
            if (beanDesc == null) {
                beanDesc = _mapper.getSerializationConfig().introspectClassAnnotations(type);
            }

final ApiModel model = type.getRawClass().getAnnotation(ApiModel.class);
            if (model != null &amp;&amp; StringUtils.isNotBlank(model.value())) {
                return _typeNameResolver.nameForType(type);
            }
            PropertyName rootName = _intr.findRootName(beanDesc.getClassInfo());
            if (rootName != null &amp;&amp; rootName.hasSimpleName()) {
                return rootName.getSimpleName();
            }
            return _typeNameResolver.nameForType(type);
        }
    }
and registering it:
&nbsp;
ModelConverters.getInstance().addConverter(new CustomSchemaNameResolverConverter(Json.mapper()));

&nbsp;

ronratovsky · Answer

Can you provide the openapi.json or swagger.json you get from your application?

priyapitaliya · Answer

Hi RonRatovsky ,
Thank you for your response. Please find my json file.

ronratovsky · Answer

If I follow everything you shared correctly, it looks like that by overriding the JSON model name, you end up having two separate objects with the same name, and one ends up canceling the other when it's translated to the definition. You'd have to give the models a distinct name, otherwise it'll keep happening.

priyapitaliya · Answer

Yes agreed, But is there any way to resolve this. As i can not change json root name value.

Forum Discussion

Swagger UI, @ApiResponse doesn't give correct response as a examle value.

7 Replies

Related Content

Swagger Response In Array

@ApiResponse messages inheritance

Empty object in response in Swagger ui

SOAPUI Json Response is not same as POSTMAN response OR Swagger response

swagger- specific_Api

Recent Discussions

ID_TOKEN as the header in the Google OAUTH2.0

How to hide an endpoint from openaopi 3.0

I can't see the "add item" button in swagger UI

Swagger Convertor Gateway Time-out

Authorization Tag For Basic BASE64 Encoding