java - 在 Spring Boot (Maven) 中显示 OpenAPI 3.0 YAML 文件-6ren

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

转载作者：行者123 更新时间：2023-12-03 18:07:28

25

4

我觉得我错过了一些简单的东西，但我的搜索都没有让我得到我希望/寻找的答案。

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

我做了什么
花了超过 3 个小时阅读各种帖子，观看谈论 Springfox 的 swagger 和 swagger-ui(以及其他内容)的 YouTube 视频
这会“即时”生成文档，我想显示 YAML 文件

我看过几篇讨论下载 swagger-ui github 存储库、解压缩它并修改 index.html 以指向我的 YAML 文件而不是它的默认文件的帖子。
虽然这是可行的，但它需要我手动下载、更新文件并重新打包它们(不是一个大问题，但似乎比我预期的要多)

正在寻找解决方案
理想情况下，我希望有一个 Maven 插件，我可以设置并传递一个配置选项，告诉它 YAML 文件所在的位置，它会简单地显示它

提前致谢

最佳答案

您可以将文件作为静态资源提供，方法是将其添加到 Spring Boot 默认静态资源位置之一(src/main/resources/META-INF/resources、src/main/resources/resources、src/main/resources/static, src/main/resources/public) 或通过覆盖默认位置并添加您的 open-api yaml 文件所在的自定义路径(设置 spring.resources.static-locations 属性)。

关于java - 在 Spring Boot (Maven) 中显示 OpenAPI 3.0 YAML 文件，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/51791614/

25

4

0

文章推荐： java - 在不打开 PDF 的情况下在客户端浏览器打印 PDF

文章推荐： f# - 如何在 F# 中将字典 "convert"转换为序列？

文章推荐： perl - 为什么我不能写@F[1..-1] 来获取元素 1..last？

文章推荐： linq - 从 Azure 云表删除时出错 - ResourceNotFound

yaml - yaml/yaml 多行转义序列中的 Markdown ？
是否可以在 yaml 中存储未转义的 Markdown 文档？我测试过 key:|+ markdown text block that could have any combination o
yaml - 为什么不能像四行 YAML 那样解析二行 YAML？
在解析使用两个空格缩进创建的 YAML(使用 Ruby 2.5/Psych)时，我看到了奇怪的行为。同一个文件，每行缩进四个空格 - 在我看来 - 正如预期的那样。两个空格: windows:
yaml - Yaml 中的三元运算符
如何在 yaml 文件中使用三元运算符让 snakeparser 解析它我使用 groovy 来解析表达式，!e 标签帮助我这样做。现在，当我使用三元运算符时，解析器会失败。 name : abc
yaml - YAML 中的多行键
是否可以有这样的多行键？ mykey: - > key one: keytwo: val 其中 keyone 被视为一个键。我想解析 yaml 以产生: { mykey:
yaml - 如何从另一个 YAML anchor 引用 YAML anchor ？
我有一个 YAML 文件，它有几个不同的键，我想为其提供相同的值。此外，我希望该值易于配置。请参阅下面的 YAML 以了解我的特定用例: --- # Options for attribute_va
yaml - YAML 中的字符串插值
在 Perl 中，我可以执行以下操作: my $home = "/home"; my $alice = "$home/alice"; 我可以在 YAML 中执行以下操作: Home: /home Al
yaml - YAML 中空字典的语法
如何在 YAML 中表示空字典？ IE。它在语义上应该等同于空的 json-object {}。最佳答案简短回答:使用 {} 在 yaml 中有两种表示映射(字典)的方法； flow mappin
yaml - yaml 文件中的条件是否可行？
我需要根据 if 条件再添加一个名称。如果另一个 .yml 文件中的变量值为“yes”，则在列表中添加新名称我的 yaml 文件中有以下代码: JsNames: - name: 'jquery.m
yaml - YAML 中的管道符号有什么用？
我是 yaml 新手，我对用于多行的管道符号 (|) 有疑问。 YAML 是否有类似下面的语法？ test: |6+ 在下面的两个 YAML 文件中，第一个有效，第二个无效。我不知道是什么原因造成的。
yaml - YAML 中的复杂映射键是什么？
关于 YAML specs关于问号有2.11段: A question mark and space (“? ”) indicate a complex mapping key. Within a b
yaml - 用注释美化 YAML
1。摘要我找不到如何自动美化我的 YAML 文件。 2。数据示例: 我有 SashaPrettifyYAML.yaml 文件: sasha_commands: # Sasha comm
yaml - 了解 YAML
我试图理解 YAML 的基本概念。我没有找到任何相关文档可以消除我的疑虑。例如: product: - sku : BL394D quantity : 4
yaml - 用注释美化 YAML
1。摘要我找不到如何自动美化我的 YAML 文件。 2。数据示例: 我有 SashaPrettifyYAML.yaml 文件: sasha_commands: # Sasha comm
yaml - YAML 键中的空格
是否有在 YAML 键中使用空格的正确方法？喜欢 a test: "hello world!" 或 "a test": "hello world!" 或者这只是一个坏主意，应该使用 a_test: "
Perl YAML::Load 无法加载 YAML::Dump 转储的 YAML
我在 YAML 中遇到这个问题通过 perl 使用时。谁能告诉我哪里出了问题。我有一个代码片段 use YAML; ... my $ifdef_struct = YAML::Load(': unde
yaml-cpp - 尝试使用 yaml-cpp 解析 OpenCV YAML 输出
我有一系列 OpenCv 生成的 YAML 文件，想用 yaml-cpp 解析它们我在简单的事情上做得很好，但矩阵表示很困难。 # Center of table tableCenter: !!op
yaml - ROS YAML 文件中的环境变量？
有没有办法在启动文件期间加载的 ROS yaml 文件中使用环境变量？例如，测试启动: 例子.yaml: vehicle_name: "${VEHICLE_NAME}_robot
yaml - 我可以使用 YAML 元数据设置命令行参数吗
Pandoc 支持 YAML metadata block在 Markdown 文档中。这可以设置标题和作者等。它还可以通过更改字体大小、边距宽度和赋予包含的图形的框架大小来操纵 PDF 输出的外观。
yaml-cpp - yaml-cpp中如何指定Null节点的输出格式？
我使用当前(2013/12/12)最新版本的 yaml-cpp。我注意到 YAML::Load("")和 YAML::Load("---\n...") 导致 Null 节点，即 YAML::Load
yaml - 是否有任何简化的 YAML 格式变得普遍？
我喜欢 YAML。等等，让我备份。我喜欢看起来像这样的 YAML，甚至比 JSON 还要多: Projects: C/C++ Libraries: - libyaml # "C"

首页

博学

6Ren·AI

商城

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