开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

社区首页 >问答首页 >使用Swagger2.x通过Maven生成HTML文档

问使用Swagger2.x通过Maven生成HTML文档
EN

Stack Overflow用户

提问于 2019-02-19 15:43:55

回答 1查看 2.1K关注 0票数 4

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

在这些项目中使用的底层REST框架是泽西岛。我从昂首阔步中找到了文档，但是它似乎没有任何简单地生成HTML的例子。他们的大多数示例似乎将API文档嵌入到实际服务本身中。

所以我的问题是：

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

EN

回答 1

Stack Overflow用户

发布于 2019-02-27 16:40:08

您需要使用swagger-codegen来生成一个HTML。

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

要使用swagger-codegen生成HTML，首先需要生成一个OpenAPI文档。由于您已经将泽西岛作为REST框架，所以将swagger作为依赖项引入项目并注释所有API servlet可能是最简单的方法。这样做，将告诉swagger读取所有代码并生成OpenAPI规范。您可以按照https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration中的步骤开始。

祝好运!

票数 1

EN

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/54770049

复制

相似问题