当前位置: 首页 > 面试题库 >

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

鲜于温书
2023-03-14
问题内容

我只是按照本指南开始使用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 {...}


 类似资料:
  • 问题内容: 我只是按照本指南开始使用swagger ,但是我发现一些非常奇怪的东西对我来说毫无意义。 据我所记得,当您拥有API版本号2的文档时,应使用v2 / api-docs。 因此,默认值仅应为api-docs,但出于某些奇怪的原因,我发现默认值为v2 / api-docs。 检查库文档,我发现了这一点。 如何覆盖该值,而以后又无法使用v2?(当我的API达到v2,但我也想显示旧版文档时)。

  • 我有一个带有springfox swagger 2.9.2的springboot应用程序,对于我的一个微服务,在swagger文档中生成的swagger基url在末尾添加了“/v2/api-docs”,似乎没有明显的原因。 下面是我的应用程序属性文件的样子 我有一种感觉,我错过了一些愚蠢的东西。

  • 首先,我的声明是: 我的主要活动获取编号和文本: 我的Activity2应该得到数字和文本: 文本很受欢迎,但数值始终为0。

  • 我尝试使用@api和@apimodel来重命名我的api引用,但似乎什么都不起作用。它总是使用类名。Im使用swagger2+springfox 2.4+Springboot。

  • 为什么springfox-swagger2 UI告诉我据我所知,我使用的是典型的Swagger spring-boot配置。 正如您在屏幕截图中看到的,支持UI的swagger-fox url是example.com/api。注意:当我导航到:https://localhost:9600/api/v2/api-docs/时,会得到一个标准的Spring。我怀疑这是问题的根源?我没有看到Spring

  • 我如何访问生成的swagger-ui.html?或者index.html我似乎在我的项目中找不到这个文件。啊啊!