从现有Java代码生成.yaml文件？

Question

我有办法从现有的Java代码生成a.yaml文件（我使用Swagger编辑器）吗？

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

Answer 1

从代码生成swagger文档是swagger-core提出的一个功能。您可以在代码中添加一些Java注释，以生成YAML文件。

提出代码生成和yaml生成是swagger的一个很好的功能，让您可以选择使用API​​优先或代码优先方法。

您可以在此处找到有关swagger注释的更多信息：https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X

Answer 2

接受的答案不正确。 从现有代码生成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）