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

如何将Swagger OpenAPI规范添加到spring boot项目中?

徐智渊
2023-03-14

我找到了这个项目https://github.com/OAI/OpenAPI-Specification据我所知,我们可以用编写文档。json/。yml文件。而且,我能看到http://editor.swagger.io/它可以被渲染成。html文件。

我的问题是-我怎么能生成静态. html页面从. json/. yml文件?有任何教程的Spring引导应用程序吗?我应该以某种方式设置. json/. yml文件昂首阔步的配置和获得. html文件留档?

共有1个答案

潘弘壮
2023-03-14

无需从. yml. json文件中生成HTMLs、JavaScript和CSS资产的集合。只需将YAML/JSON文件传递给运行Swagger用户界面的服务器,Swagger用户界面将从那些符合Swagger的应用编程接口动态生成漂亮的留档。petstore的例子应该会给你这个想法。

您可以使用像Jenkins这样的构建引擎(CI/CD服务器或其他什么)来自动化留档发布过程。例如,每个REST API存储库应该至少提供这些. yml. json文件中的一个(顺便说一下,这些文件是由Swagger Editor生成的)。然后,每次推送到该存储库后,Jenkins将获取这些. yml. json文件,并将其上传到Swagger UI启动和运行的文档服务器。

REST API开发人员可以与客户机开发人员共享API文档链接,还可以确信中的每一个更改。yml。json文件将反映在文档中。他们只需要推动变革。由于您需要维护那些与招摇兼容的API,我个人建议使用。yml文件,只是因为它更具可读性。

 类似资料:
  • 问题内容: 所以,我想要的是选择一个项目时要运行的另一段代码。但是我的问题是,如何对特定项目实施? 这是我的代码: 我该怎么做才能添加到“车辆”,“自行车/自行车”,“船”,“房屋”,“企业”,“对象”,“工作”,“等级”和“许可证”项中? 问题答案: 如果您希望在选择更改时发生某些事情,则不希望使用MouseListener,而希望使用。它不仅是正确的抽象,而且请记住,不使用鼠标就可以更改选择。

  • 问题内容: Eclipse Helios 3.6 Windows XP SP3 我已经使用Eclipse通过以下方式下载了guava SDK: 1)在Eclipse中,转到 帮助 >安装新软件… 2)在“ 使用: ”文本框中,我使用了以下URL http://svn.codespot.com/a/eclipselabs.org/guava- bundle/trunk/repository/ 3)它

  • 我有以下项目:https://github.com/glusk2/sprouts 我尝试将添加到根目录文件中的整个项目中,如下所示:

  • 问题内容: 我设法下载了Eclipse Helios的svn插件。然后,我设法将一个新的存储库添加到我选择的驱动器中。但是我看不到如何知道已经创建的项目?有人可以告诉我我该怎么做。 谢谢 问题答案: 就像是: 右键单击您的项目。 选择团队->共享项目。 该向导将指导您进行初始导入。 实际上,Initial Import不会将任何代码放入项目存储库中,而只是将项目详细信息放入仓库中。因此,您需要执行

  • 问题内容: 如何将库项目(例如Sherlock ABS)添加到Android Studio? (不是旧的基于ADT Eclipse的捆绑包,而是新的Android Studio。) 问题答案: Android Studio 1.0更新 自从发布Android Studio 1.0(以及许多版本在v1.0到我上次回答之时的第一个版本)以来,某些事情已经发生了变化。 我的描述着重于通过Gradle文件

  • 问题内容: 我需要完成以下任务: 从: (向每行添加一个元素)到: 我已经尝试做类似a [n] = array([1,3,4,x])的事情 但是numpy抱怨形状不匹配。我尝试遍历并将元素x附加到每个项目,但是更改未反映出来。 关于如何实现此目标的任何想法? 问题答案: 对于有python经验的人来说,将数据追加到现有数组是很自然的事情。但是,如果您发现自己定期附加到大型数组,则会很快发现NumP