38

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

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

所以,默认应该只有 api-docs,但出于某种奇怪的原因,我发现默认是 v2/api-docs。

检查图书馆文档我发现了这个

如何在以后无法使用 v2 的情况下覆盖该值?(当我的 API 达到 v2 但我还想展示遗留文档时)。

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

4

1 回答 1

65

/v2/api-docsURL 是 SpringFox 用于文档的默认值。v2不是指您的 API 的文档版本(可以在配置中更改)Docket,而是指正在使用的 Swagger 规范的版本。查看此处的文档以自定义 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 {...}
于 2016-09-12T14:51:41.430 回答