java - 在 Javax(在 JEE 下)上通过 Swagger 生成 API 文档？

Question

晚上，

我们正在尝试将 Swagger 实现到现有的 REST 项目中，该项目在带有 Java EE 的 Wildlfly 上运行。 目的是在运行时为 REST-API 生成文档。

然而，在我们的 Gradle 设置中添加必要的依赖项 (io.swagger:swagger-jaxrs) 之后，我们尝试通过 web.xml 设置 Swagger 生成器

<servlet-mapping>
<servlet-name>SwaggerConfig</servlet-name>
<url-pattern>/api/documentation</url-pattern>
</servlet-mapping>

<servlet>
<servlet-name>SwaggerConfig</servlet-name>
<servlet-class>io.swagger.jaxrs.config.DefaultJaxrsConfig</servlet-class>
<init-param>
<param-name>api.version</param-name>
<param-value>1.0.0</param-value>
</init-param>
<init-param>
<param-name>swagger.api.basepath</param-name>
<param-value>http://localhost:8080/api/documentation</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet> 

我们确实设法通过 SOAP 解决了 */api/documentation 下的 servlet，但似乎没有生成任何文档、JSON 文件或其他文件，我们似乎也无法弄清楚在哪里/如何设置生成。

如有任何帮助、建议或我们可能遗漏的指南链接，我们将不胜感激。

Answer 1

Swagger 生成一个 HTML 页面，在您的后端服务器运行时可以访问该页面。

尝试/api/index.html