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

如何从现有的Spring Boot应用程序生成OpenAPI3.0规范?

后树
2023-03-14

我有一个项目(Spring Boot App+Kotlin),我希望有一个开放的API3.0规范(最好是在YAML)。Springfox库很好,但它们生成了Swagger2.0JSON。从我的控制器中的注释生成开放Api 3.0规范的最佳方法是什么?从头开始写是唯一的方法吗?

共有1个答案

顾昊穹
2023-03-14

我们在kotlin项目中使用了springdoc-openapi库,它满足了使用Spring Boot项目自动生成API文档的需要。

它会自动将swagger-ui部署到spring-boot应用程序中

然后,Swagger UI页面可以在以下网址获得:-http://server:port/context-path/swagger-ui.html。对于json格式,OpenAPI描述可以在以下url获得:-http://server:port/context-path/v3/api-docs

 <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-ui</artifactId>
      <version>1.2.32</version>
  </dependency>
 类似资料:
  • 现在,我想生成一些样板服务器端代码:控制器及其方法。我的API将使用ASP.NET Core2编写。那么,是可能使用某种发电机还是我应该手动? 附言。我知道我可以生成客户端代码,但我现在不需要它...

  • 我有一个Angular project web app,在我使用“ng build…”构建它之后,它正在Apache web服务器中成功运行命令现在,我想让它成为Android应用程序,为此,我尝试使用Cordova。首先,我创建了一个Cordova项目,然后在www目录下,我放置了来自NG的文件。是的,在那之前我还使用了Cordova平台add android。但是,当我在模拟器或真实设备上安装

  • 我对springfox和Swagger2都是新手。我一直在尝试将SpringFox/Swagger2与我的spring boot微服务集成以生成API文档。 我遵循了“http://springfox.github.io/springfox/docs/snapshot/”站点中给出的步骤。但是我没有成功的带来api文档页面。 每当我试图点击URL“http://localhost:8081/swa

  • 我希望文档的显示方式类似于它在特定于应用程序的上下文路径下的文档中提到的方式。你能告诉我我错过了什么吗?

  • 我正在使用gradle创建一个spring boot应用程序。我需要创建一个jar,其中包含在(aws)ec2实例上部署所需的所有库。 我正试图创建一个罐子由。。。 1)点击项目结构 2)然后点击工件 3)点击- 4) 用默认设置点击ok 5) 点击build标签 6)我有一个jar文件,但它不包含类。