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

标签 java swagger springfox

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

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

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

检查我找到的库文档 this .

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

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

最佳答案

/v2/api-docs URL 是 SpringFox 用于文档的默认 URL。 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 {...}

关于java - 为什么使用 springfox 和 Swagger2 时 v2/api-docs 是默认 URL?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/39401010/

相关文章:

java - 从 map 中删除条目而不进行迭代

swagger - 如何在定义中引用 self?

java - Swagger 2 接受 xml 而不是 json

java - 在编译时为基于 springfox 的项目生成 swagger JSON 文件

java - 下载文件名中含有特殊字符的文件

java - 循环后如何将这些单词构建为一个句子?

c# - WebAPI Controller 方法未显示在 swagger 中

spring-boot - Springfox Java Bean 验证未显示在 Swagger 输出中

java - 用于自定义响应的 Swagger 注释?

java - MongoDB : find matching elements in an array with given attributes using java driver