從現有的Java代碼生成Swagger文檔？

Question

有沒有一種方法可以從現有的Java代碼生成搖搖欲墜的文檔（ YAML格式）？

我目前正在使用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）

Answer 2

swagger-core提出了從代碼生成swagger文檔的功能。 您可以在代碼中添加一些Java注釋，以生成YAML文件。

同時提出代碼生成和yaml生成是swagger的一項重要功能，它使您可以選擇使用API​​優先還是代碼優先的方法。

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