通过Maven使用Swagger 2.x生成HTML文档

Question

我正在寻找在我的一些不同项目中生成一些API文档，希望使用Swagger。从未使用过Swagger，我试图找到一种非常简单的解决方案来通过Maven生成HTML文档。

这些项目中使用的底层REST框架是Jersey。我从Swagger找到了文档，但似乎没有简单生成HTML文件的任何示例。他们的大多数示例似乎将API文档嵌入到实际的服务本身中。

所以我的问题是：

• 如何通过Maven使用Swagger生成HTML文档？
• 是否将文档和正常服务一起附在REST应用程序上？

Answer 1

您将需要使用swagger-codegen生成HTML。

https://github.com/swagger-api/swagger-codegen#generating-static-html-api-documentation

要使用swagger-codegen生成HTML文档，您首先需要生成一个OpenAPI文档。由于您已经在使用Jersey作为REST框架，因此最容易将招摇作为依赖进入您的项目并注释所有API servlet。这样做将使swagger读取所有代码并生成OpenAPI规范。您可以按照https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration中的步骤开始。

祝你好运！