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

java springfox swagger

2022-09-01 04:25:33

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

据我所知，当您拥有API版本号为2的文档时，应该使用v2 / api-docs。

因此，默认值应该只是 api-docs，但是出于某种奇怪的原因，我发现默认值是 v2/api-docs。

检查库文档，我发现了这个。

如何覆盖该值，以免以后无法使用 v2？（当我的API达到v2时，我也想显示遗留文档）。

或者也许我使用v2的概念是错误的？有人可以帮我吗？

答案 1

URL是SpringFox用于文档的默认值。不是指 API 的文档版本（可以在配置中更改），而是正在使用的 Swagger 规范的版本。查看此处的文档，了解如何自定义 Swagger 文档 URL。简而言之，您需要修改环境属性以更改文档将出现在以下位置的 URL：/v2/api-docsv2Docket

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

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

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

答案 2