【问题标题】:Does swagger save any files大摇大摆是否保存任何文件
【发布时间】:2019-08-07 10:28:50
【问题描述】:

我们在 spring 项目中使用 swagger 来生成文档。我的任务是为尚未使用 swagger 的生产版本生成文档。所以我注入了依赖项,从开发版本中复制了配置文件和 swagger 控制器。当我启动项目(还没有文档的生产版本)并打开 swagger-ui 时,我会从开发版本中获取所有数据。如果我将 swagger 映射路径更改为不同的示例: 原始"/api/.*",新"/api2/.*"。 我得到没有文档的干净页面,为了检查它是否正常工作,我添加了一些注释并且一切正常。所以我想大摇大摆地在我的电脑上保存了一些文件,但我找不到它们。这是我第一次处理招摇,所以如果我错了,请纠正我。任何帮助将不胜感激。提前致谢。

【问题讨论】:

  • 您说您生成文档。这是否使用代码中的招摇注释完成,如果是这样,生产中的代码是否已经注释?如果是,那么swagger根据代码中的注解生成生产文档也就不足为奇了。
  • 无生产版本不使用swagger。我的工作是在我们发布具有完整文档的下一个版本之前为客户创建一些文档。
  • 那么你是如何“注入”大摇大摆的依赖关系的。你是在使用 springfox swagger 还是常规 swagger。如果您使用后者,可能是您将生成的包含文档的 swagger.json 文件复制到了生产版本?
  • Springfox swagger 扫描 Spring MVC 的注解以生成文档(swagger.json 文件)。因此,如果在您的生产代码库中配置了 swagger springfox(而不仅仅是依赖项),那么文档将自动生成。
  • 有趣的问题...欢迎投票...这将使您以更多方式表达您的感激之情;-)

标签: java rest api spring-boot swagger-2.0


【解决方案1】:

Swagger 不会将任何文件保存到您的计算机。您通过注释端点添加的信息用于生成 swagger 文件(通常是 YAML 或 JSON 格式)。

Swagger-UI 只需下载生成的文件并将此信息可视化。

您当然可以自己下载文件(指向 swagger-ui 的 URL),修改其中的任何特定于开发人员的路径,然后将此静态文件上传到您的产品服务器。当然,如果 prod 和 dev 之间存在差异,这可能无法反映正确的 prod 端点。

【讨论】:

  • 我在 localhost 上测试项目。仍然可能有一些配置连接到 dev。我会注意的。谢谢。
猜你喜欢
  • 1970-01-01
  • 2018-11-29
  • 2014-07-19
  • 2015-12-14
  • 1970-01-01
  • 1970-01-01
  • 2018-12-21
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多