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


问题内容

我只是按照本指南开始使用swagger ,但是我发现一些非常奇怪的东西对我来说毫无意义。

据我所记得,当您拥有API版本号2的文档时,应使用v2 / api-docs。

因此,默认值仅应为api-docs,但出于某些奇怪的原因,我发现默认值为v2 / api-docs。

检查库文档,我发现了这一点

如何覆盖该值,而以后又无法使用v2?(当我的API达到v2,但我也想显示旧版文档时)。

还是我使用v2的概念是错误的?有人可以帮我弄这个吗?


问题答案:

/v2/api- docsURL是默认是SpringFox使用的文档。该v2不是指你的API的文档版本(可在更改Docket配置),但所使用的扬鞭规范的版本。在此处查看用于自定义Swagger文档URL的文档。简而言之,您需要修改环境属性以更改文档将出现在以下位置的URL:

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

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

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