如何将 Swagger OpenAPI 规范添加到 spring 引导项目？
How to add Swagger OpenAPI specification to spring boot project?
我找到了这个项目https://github.com/OAI/OpenAPI-Specification
据我了解，我们可以在 .json/.yml 文件中编写文档。另外，我可以在 http://editor.swagger.io/ 中看到它可以呈现到 .html 文件。
我的问题是 - 如何从 .json/.yml 文件生成静态 .html 页面？ spring 启动应用程序有任何教程吗？我是否应该以某种方式将 .json/.yml 文件设置为 swagger 配置并获取带有文档的 .html 文件？
无需从 .yml 或 .json 文件生成 HTML、JavaScript 和 CSS 资产的集合。只需将 YAML/JSON 文件传递给服务器 运行 Swagger UI and Swagger UI will dynamically generate beautiful documentation from those Swagger-compliant APIs. The petstore 示例应该可以让您明白。
您可以使用像 Jenkins 这样的构建引擎（CI/CD 服务器或其他）来自动化文档发布过程。例如，每个 REST API 存储库应至少提供这些 .yml 或 .json 文件之一（顺便说一句，这些文件由 Swagger 编辑器生成）。然后在每次推送到该存储库后，Jenkins 将获取那些 .yml 或 .json 文件并将它们上传到 Swagger UI 和 运行 已启动的文档服务器。
REST API 开发人员可以与客户端开发人员共享 API 文档 link，并且可以确信 .yml 或 .json 中的每个更改文件将反映在文档中。他们只需要推动变化。由于您需要维护那些符合 Swagger 标准的 API，我个人建议使用 .yml 文件，因为它更具可读性。
我找到了这个项目https://github.com/OAI/OpenAPI-Specification
据我了解，我们可以在 .json/.yml 文件中编写文档。另外，我可以在 http://editor.swagger.io/ 中看到它可以呈现到 .html 文件。
我的问题是 - 如何从 .json/.yml 文件生成静态 .html 页面？ spring 启动应用程序有任何教程吗？我是否应该以某种方式将 .json/.yml 文件设置为 swagger 配置并获取带有文档的 .html 文件？
无需从 .yml 或 .json 文件生成 HTML、JavaScript 和 CSS 资产的集合。只需将 YAML/JSON 文件传递给服务器 运行 Swagger UI and Swagger UI will dynamically generate beautiful documentation from those Swagger-compliant APIs. The petstore 示例应该可以让您明白。
您可以使用像 Jenkins 这样的构建引擎（CI/CD 服务器或其他）来自动化文档发布过程。例如，每个 REST API 存储库应至少提供这些 .yml 或 .json 文件之一（顺便说一句，这些文件由 Swagger 编辑器生成）。然后在每次推送到该存储库后，Jenkins 将获取那些 .yml 或 .json 文件并将它们上传到 Swagger UI 和 运行 已启动的文档服务器。
REST API 开发人员可以与客户端开发人员共享 API 文档 link，并且可以确信 .yml 或 .json 中的每个更改文件将反映在文档中。他们只需要推动变化。由于您需要维护那些符合 Swagger 标准的 API，我个人建议使用 .yml 文件，因为它更具可读性。