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

Question

有没有一种方法可以YAML从现有的Java代码生成标准格式的文档？

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

Answer 1

从现有代码生成YAML文件的过程很简单。

添加以下依赖项（我碰巧使用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）