通过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框架，因此最简单的方法是将swagger作为项目的依赖项，并注释所有API servlet。这样做会告诉swagger阅读所有代码并生成OpenAPI规范。您可以按照https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration中的步骤开始操作。

祝好运！