当前位置: 首页 > 知识库问答 >
问题:

在Spring Boot(Maven)中显示OpenAPI 3.0 YAML文件

上官彬
2023-03-14

我觉得我错过了一些简单的东西,但是我的搜索都没有给我带来我希望/寻找的答案。

问题陈述
我正在编写一个Spring Boot应用程序,它公开了一系列RESTful API。出于各种原因,我有一个包含API文档(用OpenAPI 3.0编写)的YAML文件。我正在寻找一种简单(毕竟是Spring Boot)的方式来显示该文档。

我所做的
花了3个多小时阅读各种帖子,观看关于Springfox的招摇过市和招摇过市用户界面(以及其他内容)的youtube视频
这会生成“动态”文档,我想显示YAML文件

我看到过几篇帖子讨论了下载github repo的大摇大摆的用户界面、解压并修改索引。html指向我的YAML文件,而不是它的默认文件
虽然这是可行的,但它需要我手动下载、更新文件并重新打包(这不是一个大问题,但似乎比我预期的要多)


理想情况下,我希望有一个Maven插件,我可以设置并传递一个配置选项,告诉它YAML文件的位置,它会简单地显示它

提前感谢

共有2个答案

颜志学
2023-03-14

您可以使用Maven(或任何您使用的构建工具)将文件复制到标准位置之一,而不是更改静态资源的位置。我使用OpenAPI生成器从规范生成源代码,并使用它生成规范的HTML视图。

在构建期间,我也会将该文件复制到静态资源位置。不过,我还没有想出一个简单的方法来让斯瓦格用户界面工作。超文本标记语言视图是一种妥协。

边健
2023-03-14

您可以将该文件作为静态资源提供服务,或者将其添加到Spring引导默认静态资源位置之一(src/main/Resources/META-INF/Resources,src/main/Resources/Resources,src/main/Resources/stest,src/main/Resources/Public),或者覆盖默认位置在open-api yaml文件所在的位置添加您的自定义路径(设置spring.resources.static-位置属性)。

 类似资料:
  • 问题内容: 我正在开发一个Swing应用程序,其中必须显示HTML文件。 我正在为此使用控件。它显示的是HTML文件的内容,但格式与实际HTML文件中的原始格式不同。 不支持该元素。与其加载目标文件,不如显示它。 Swing中是否还有其他内置控件来浏览HTML文件而不是? 我正在使用以下代码: 问题答案: 在核心Java中进行更高级的HTML呈现的最佳选择是使用基于JavaFX的组件,如向Java

  • 文件:/springboot1_firstwebapp/pom.xml

  • 我已经为我的spring boot应用程序配置了测微计和prometheus,我可以在endpoint/执行器/prometheus处看到以下指标(使用计时器生成): 但当我在Grafana中运行其中一个查询(针对prometheus实例配置)时,我没有看到任何结果。 这需要任何配置吗?

  • 问题内容: 我需要在运行的Jenkins作业的 控制台输出 中显示日志文件(测试计算机中存在)。 那可能吗?如果是,我该怎么做? 问题答案: 根据需要选择执行Windows批处理命令或执行Shell 然后使用“ cat log.file”(Linux)“ type log.file”(Windows)显示

  • 问题内容: 我正在尝试使用Maven 3 在Spring Boot应用程序中设置活动配置文件。在我的pom.xml中,将默认的活动配置文件和属性spring.profiles.active设置 为development: 但是每次我运行应用程序时,都会在日志中收到以下消息: 并且将SpringBoot配置文件设置为默认值(读取application.properties而不是application