springfox-swagger 3.0.0 - SNAPSHOT - JSON schema not being generated as it was before te update

Please take the time to search the repository, if your question has already been asked or answered.

-3.0.0-SNAPSHOT

• SpringBoot 2.2.7 Webflux
• JsonView

I’m using SpringFox swagger in SpringBoot with JsonView support

My docket configuration is:

final List<ResponseMessage> globalResponses = Arrays.asList(
                new ResponseMessageBuilder().code(400)
                                            .message(ErrorMessages.INVALID_REQUEST)
                                            .responseModel(new ModelRef("InvalidDataResponse"))
                                            .build(),
                new ResponseMessageBuilder().code(401)
                                            .message(ErrorMessages.UNAUTHENTICATED)
                                            .responseModel(new ModelRef("UnauthenticatedResponse"))
                                            .build(),
                new ResponseMessageBuilder().code(403)
                                            .message(ErrorMessages.FORBIDDEN)
                                            .responseModel(new ModelRef("ForbiddenResponse"))
                                            .build(),
                new ResponseMessageBuilder().code(500)
                                            .message(ErrorMessages.INTERNAL_SERVER_ERROR)
                                            .responseModel(new ModelRef("InternalServerError"))
                                            .build()
        );

        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .globalResponseMessage(RequestMethod.GET, globalResponses)
                .globalResponseMessage(RequestMethod.POST, globalResponses)
                .globalResponseMessage(RequestMethod.DELETE, globalResponses)
                .globalResponseMessage(RequestMethod.PATCH, globalResponses)
                .globalResponseMessage(RequestMethod.PUT, globalResponses)
                .useDefaultResponseMessages(false)
                .genericModelSubstitutes(ResponseEntity.class)
                .alternateTypeRules(
                        newRule(typeResolver.resolve(
                                Mono.class,
                                typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
                                typeResolver.resolve(WildcardType.class))
                )
                .additionalModels(
                        typeResolver.resolve(InvalidDataResponse.class),
                        typeResolver.resolve(UnauthenticatedResponse.class),
                        typeResolver.resolve(ForbiddenResponse.class),
                        typeResolver.resolve(NotFoundResponse.class),
                        typeResolver.resolve(InternalServerResponse.class)
                )
                .host(baseUrl);

And for the following endpoint/annotations:

    @ApiOperation(
            value = "List all projects"
    )
    @ApiResponses(value = {
            @ApiResponse(
                    code = 200,
                    message = SuccessMessages.CONTENT_READY
            )
    })
    @GetMapping(path = "/projects", produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseBody
    @JsonView({View.List.class})
    Mono<ResponseEntity<SuccessResponse<PaginatedListResult<ProjectModel>>>> getAll(

Now i get the schema of :

"responses": {
          "200": {
            "description": "content ready",
            "schema": {
              "$ref": "#/definitions/Error-ModelName{namespace='reactor.core.publisher', name='Mono«ResponseEntity«SuccessResponse«PaginatedListResult«Project»»»»'}"
            }
          }
        }

And the model definition is exported as :

"SuccessResponse«PaginatedListResult«Project»»View": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "example": "content ready!"
        },
        "result": {
          "example": "null",
          "$ref": "#/definitions/PaginatedListResult«Project»View"
        },
        "status": {
          "type": "boolean",
          "example": true
        }
      },
      "title": "SuccessResponse«PaginatedListResult«Project»»View",
      "description": "Success response model"
    }

Before the last update this was working with the schema being generated similar to what is shown below

"responses": {
          "200": {
            "description": "content ready",
            "schema": {
              "$ref": "#/definitions/Mono«ResponseEntity«SuccessResponse«PaginatedListResult«Project»»»»"
            }
          }
        }

....

"Mono«ResponseEntity«SuccessResponse«PaginatedListResult«Project»»»»": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "example": "content ready!"
        },
        "result": {
          "example": "null",
          "$ref": "#/definitions/PaginatedListResult«Project»View"
        },
        "status": {
          "type": "boolean",
          "example": true
        }
      },
      "title": "SuccessResponse«PaginatedListResult«Project»»View",
      "description": "Success response model"
    }`

What should i do different to fix this up ?

[hexmind]

Hi,

With the latest approach of going with globalResponses instead of globalResponseMessage, how can we have custom response models which we used to create with ModelRef.

new ModelRef(“ErrorResponse500”)

There is a sad example with DTO class:

new ResponseBuilder()
        .code(code)
        .description(description)
        .representation(MediaType.ALL)
        .apply(r -> r.model(m ->
                m.referenceModel(ref ->
                        ref.key(k ->
                                k.qualifiedModelName(q ->
                                        q.namespace("com.example.api").name("ErrorDto"))))))
        .build();

[dilipkrish]

It should still work however. I’ll try and fix that 😃 Thanks for reporting