Why is v2/api-docs the default URL when using springfox and Swagger2?

The /v2/api-docs URL is the default that SpringFox uses for documentation. The v2 does not refer to your API’s documentation version (which can be changed in the Docket configuration), but the version of the Swagger specification being used. Take a look at the documentation here for customizing the Swagger documentation URL. In short, you need to modify an environment property to change the URL your documentation will appear at:

springfox.documentation.swagger.v2.path=/my/docs

This will change the default URL for the SpringFox Swagger documentation from /v2/api-docs to whatever you specify. To implement this, add the above property to a new or existing properties file, and then add it as a property source in your Springfox configuration class:

@PropertySource("classpath:swagger.properties")
@Configuration
public class SwaggerConfig {...}

Leave a Comment