java - 从现有 Java 代码生成 Swagger 文档？

Question

有没有办法从现有的 Java 代码生成 swagger 文档(采用 YAML 格式)？

我目前正在使用 YAML 文件生成 Java API 代码，但我感兴趣是否可以实现相反的过程。也就是说，我是否可以从现有的 Java 代码生成 YAML 文件？

Answer 1

从现有代码生成 swagger 定义的过程很简单。

添加以下依赖项(我碰巧使用Maven):

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

这会在您的应用程序中添加一个 swagger-ui，可以通过以下方式访问

http://<host>:<port>/swagger-ui.html

点击 API 文档 ( /v2/api-docs ) 链接，您将获得一个 JSON 文件，可以使用 http://editor.swagger.io 轻松将其转换为 YAML 文件。 (编辑 -> 转换为 YAML)