Broken basePath with AbstractPathProvider in version 2.5.0 of springfox-swagger2

• Version 2.5.0 (same in 2.6.0)
• Bug: AbstractPathProvider extension point is broken for swagger2 due to this code block in Swagger2Controller:

    Swagger swagger = mapper.mapDocumentation(documentation);
    if (isNullOrEmpty(swagger.getHost())) {
      final UriComponents uriComponents = componentsFrom(servletRequest);
      swagger.basePath(Strings.isNullOrEmpty(uriComponents.getPath()) ? "/" : uriComponents.getPath());
      swagger.host(hostName(uriComponents));
    }

Here you can see that even if the new path is getting to the Swagger object (line 1), it gets overwritten when “getHost” is checked. According to the swagger spec the host isn’t even required, so this kind of assumptions should not be made.

On the other hand, the basePath is overwritten when a host is not provided which is the main reason for this bug.

The last version that we know that works is 2.3.1.

Sample implementation of AbstractPathProvider:

    class BasePathAwareRelativePathProvider extends AbstractPathProvider {
        private String basePath;

        public BasePathAwareRelativePathProvider(String basePath) {
            this.basePath = basePath;
        }

        @Override
        protected String applicationPath() {
            return basePath;
        }
        ...
    }

[danielbcorreia]

@RestController
public class PingController {

    @ApiOperation(value = "Ping endpoint", notes = "Ping endpoint")
    @RequestMapping(value = "/ping", method = RequestMethod.GET, produces = MediaType.TEXT_PLAIN_VALUE)
    @ApiResponses(value = {@ApiResponse(code = 200, message = "OK")})
    public ResponseEntity<String> ping() {
        return ResponseEntity.ok("pong");
    }
}

We’re just trying to set the “basePath” property on the swagger spec to be, for example, “/something” (instead of the default “/”).

This was working before the change that I mentioned for X-Forwarded-Host was introduced. The blank/null host should not mean that the basePath should be touched.

We can avoid the problem by setting the hostname ourselves before that code takes place, but that is another workaround, and that is an optional field on the swagger spec.

In my opinion, a further check needs to exist when you check for isNullOrEmpty(swagger.getHost()), so you don’t override the basePath when you don’t need to. We are not using X-Forwarded-Host, so our basePath should not be overwritten.

I can try to put together a pull request to try to fix this.

[jonathannaguin]

@dilipkrish Is this available in a SNAPSHOT build for testing?