使用springfox和Swagger2时,为什么v2 / api-docs是默认URL?

时间:2016-09-08 22:17:04

标签: java swagger springfox

我刚刚开始使用swagger guide,但我发现了一些非常奇怪的东西对我来说毫无意义。

据我记忆,如果您拥有API版本号2的文档,则应使用v2 / api-docs。

所以,默认应该只是api-docs,但由于一些奇怪的原因,我发现默认是v2 / api-docs。

检查库文档我找到了this

如何在不能使用v2的情况下覆盖该值? (当我的API将达到v2但我也想展示旧版文档)。

或许我使用v2的概念是错的?有人可以帮我这个吗?

1 个答案:

答案 0 :(得分:38)

/v2/api-docs网址是SpringFox用于文档的默认网址。 v2未引用您的API文档版本(可在Docket配置中更改),但使用的是Swagger规范的版本。请查看documentation here以自定义Swagger文档URL。简而言之,您需要修改环境属性以更改文档将显示在的URL:

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

这会将SpringFox Swagger文档的默认URL从/v2/api-docs更改为您指定的任何内容。要实现此功能,请将以上属性添加到新的或现有的属性文件中,然后将其作为属性源添加到Springfox配置类中:

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