如何将OpenApi.yaml添加到您的项目

发布于 2025-02-07 12:00:59 字数 123 浏览 2 评论 0原文

如何将OpenAPI.YAML添加到现有项目中,其中已写入REST API的代码? 我应该在哪个文件夹中放置yaml文件,需要做什么“配置”才能正常工作(显示Swagger UI)?

注意:使用Dropwizard框架

How to add openapi.yaml to an existing project with already written code for REST API?
In what folder should I put the yaml file and what "configuration" needs to be done for it to work properly (display swagger UI)?

Note: using dropwizard framework

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

温折酒 2025-02-14 12:00:59

我自己使用带有Spring/Dropwizard的Open API遇到了几个问题。因此,我开始构建一种使回购集成更容易的替代方案( https://github.com/fern-api/蕨类植物)。

入门的步骤:

  1. 您可以使用npm install -g fern -api
  2. 运行fern init,它将创建一个具有API定义
  3. 运行Fern的 API目录添加Java以添加Java Generator
  4. 运行FERN GERTATE以生成Java Subproject
  5. 对Java子标记添加依赖关系,并实现您的APIS

https://docs.buildwithfern.com/#/ 这里有一个视频,介绍了如何开始使用Java。

如果要在之后添加OpenApi.yml,则可以将FERN API定义转换为有效的Open API。

抱歉,如果这不是您要寻找的答案,只是想我会分享一个可以解决您的问题的替代方案!

I was running into several issues myself using Open API with Spring/Dropwizard. So I started building an alternative that makes repo integration easier (https://github.com/fern-api/fern).

Steps to get started:

  1. You can install it with npm install -g fern-api
  2. Run fern init which will create an api directory that has an API definition
  3. Run fern add java to add the java generator
  4. Run fern generate to generate the java subproject
  5. Add a dependency on the java subproject and implement your APIs

https://docs.buildwithfern.com/#/ There's a video here on how to get started with Java.

If you want to add an openapi.yml after, you will be able to convert the fern api definition into a valid Open API.

Apologies if this wasn't the answer you were looking for, just figured I'd share an alternative that might solve your problem!

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文