Request parameters, lead to an incorrecty generated cURL request

Version: 2.9.2 (latest) Kind: Bug report

Hey, I think I’ve found a bug in the generation of the curl request, when clicking on ‘Try it out’.

I’ve got following endpoint:

@RequestMapping(method = RequestMethod.GET, path = "/ranking/country", produces = MediaType.APPLICATION_JSON_VALUE)
@ApiOperation(value = "Returns a ranking of the top countries with the most sensors")
public List<RankingItemCountry> getRankingByCountry(
        @RequestParam(defaultValue = "10") int items
) throws RankingDataException {
    if(items < 1) throw new RankingDataException(ErrorCodeUtils.INVALID_ITEMS_NUMBER);
    return sensorRepository.getRankingByCountry(items);
}

On the UI page it looks like this:

Look at the generated curl request. It is wrong isn’t it? The expected request should look like this: https://<api-url>.com/ranking/city?items=2

This results in a 404 response code. I would appreciate, if it can be fixed. Thanks for your awesome implementation!

Marc

[MaksimOrlov]

If you have two @RequestMappings with same url but different @RequestParam, with enabled urlTempkating SpringFox will generate two endpoints. Otherwise only one,the second mapping will be lost. But unfortunately, Swagger-UI doesn’t support that feature. So, it won’t be able to generate correct curl request.

More about feature https://tools.ietf.org/html/rfc6570

[studeyang]

add @ApiImplicitParam may solve your problem, like this:

@RequestMapping(method = RequestMethod.GET, path = "/ranking/country", produces = MediaType.APPLICATION_JSON_VALUE)
@ApiImplicitParam(name = "items", value = "items", dataType = "int", paramType = "param")
@ApiOperation(value = "Returns a ranking of the top countries with the most sensors")
public List<RankingItemCountry> getRankingByCountry(
        @RequestParam(defaultValue = "10") int items
) throws RankingDataException {
    if(items < 1) throw new RankingDataException(ErrorCodeUtils.INVALID_ITEMS_NUMBER);
    return sensorRepository.getRankingByCountry(items);
}