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

Question

I'm just starting using swagger following this guide, but I found out something very weird that makes no sense for me.

As far as I remember , the v2/api-docs should be used for when you have docs of the version number 2 of your API.

So, the default should be only api-docs, but for some strange reason I found that the default is v2/api-docs.

Checking the library doc I found this.

How do I override that value without later not being able to use v2? (when my API will reach a v2 but I will also want to show the legacy docs).

Or maybe my concept of using v2 is wrong? Can someone help me with this?

The v2 in the URL does not refer to your APIs version number, it is the Swagger specification version number. The current version of SpringFox uses Swagger 2.0 by default, this is what you are seeing. — woemler
that is what I was guessing it is happening! but, any idea how to show my api's documentation? — jpganz18

woemler woemler · Accepted Answer · 2016-09-12T14:51:41

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 {...}

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

1 Answers