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

标签 java spring-boot maven-3 swagger-ui openapi

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

问题陈述
我正在编写一个 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/

相关文章:

java - 确保在 Spring Boot 中 Web 服务器公开 HTTP 之前执行代码

spring-boot - Spring Boot 2.x Repackage用于与Gradle的集成测试

java - thymeleaf (th :action) not working when rendering long html

java - 无法使用 jcabi 父 pom 进行构建

java - 尝试用 Java 解魔方

java - Jaxb关于标签包装的简单问题

java - 如何使用 HtmlUnit 和 java 选择特定元素?

java - 如何向 IntelliJ IDEA 中的所有 Maven 调用添加代理 VM 参数

google-app-engine - 如何在 Maven 中更改应用引擎用户名/凭据?

java - 在android中将PDF文件转换为字节数组