为什么使用springfox和Swagger2时v2/api-docs默认为URL?
Why is v2/api-docs the default URL when using springfox and Swagger2?
我刚开始使用这个 guide 之后的 swagger,但我发现了一些对我来说毫无意义的非常奇怪的东西。
据我所知,当您拥有 API.
版本号 2 的文档时,应该使用 v2/api-docs
所以,默认应该只有api-docs,但是由于一些奇怪的原因我发现默认是v2/api-docs.
检查我发现的图书馆文档 this。
如何覆盖该值而不致于以后无法使用 v2? (当我的 API 将达到 v2 但我还想展示遗留文档时)。
或者我使用 v2 的概念是错误的?有人可以帮我解决这个问题吗?
/v2/api-docs
URL 是 SpringFox 用于文档的默认设置。 v2
不是指您的 API 的文档版本(可以在 Docket
配置中更改),而是指正在使用的 Swagger 规范的版本。查看 documentation here 自定义 Swagger 文档 URL。简而言之,您需要修改环境 属性 以更改 URL 您的文档将出现在:
springfox.documentation.swagger.v2.path=/my/docs
这会将 SpringFox Swagger 文档的默认值 URL 从 /v2/api-docs
更改为您指定的任何值。要实现这一点,请将上面的 属性 添加到新的或现有的属性文件中,然后将其作为 属性 源添加到您的 Springfox 配置中 class:
@PropertySource("classpath:swagger.properties")
@Configuration
public class SwaggerConfig {...}
我刚开始使用这个 guide 之后的 swagger,但我发现了一些对我来说毫无意义的非常奇怪的东西。
据我所知,当您拥有 API.
版本号 2 的文档时,应该使用 v2/api-docs所以,默认应该只有api-docs,但是由于一些奇怪的原因我发现默认是v2/api-docs.
检查我发现的图书馆文档 this。
如何覆盖该值而不致于以后无法使用 v2? (当我的 API 将达到 v2 但我还想展示遗留文档时)。
或者我使用 v2 的概念是错误的?有人可以帮我解决这个问题吗?
/v2/api-docs
URL 是 SpringFox 用于文档的默认设置。 v2
不是指您的 API 的文档版本(可以在 Docket
配置中更改),而是指正在使用的 Swagger 规范的版本。查看 documentation here 自定义 Swagger 文档 URL。简而言之,您需要修改环境 属性 以更改 URL 您的文档将出现在:
springfox.documentation.swagger.v2.path=/my/docs
这会将 SpringFox Swagger 文档的默认值 URL 从 /v2/api-docs
更改为您指定的任何值。要实现这一点,请将上面的 属性 添加到新的或现有的属性文件中,然后将其作为 属性 源添加到您的 Springfox 配置中 class:
@PropertySource("classpath:swagger.properties")
@Configuration
public class SwaggerConfig {...}