在JEE中使用Swagger生成API文档？

Question

晚上好，

我们正在尝试将Swagger用于运行在Java EE的Wildlfly上的现有REST项目，目的是在运行时生成REST-API文档。

然而，在将必要的依赖项（io.swagger:swagger-jaxrs）添加到我们的Gradle设置后，我们尝试通过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文件或其他文件，我们也无法弄清楚如何设置生成。如果您能提供任何帮助、建议或者我们可能错过的指南链接，我们将不胜感激。

- Alblaka

Answer 1

尝试 api/documentation/swagger.json 这就是我的文件藏着的地方 :)

我按照 swagger-core github 仓库中的指南一步一步（非常小心）地进行操作，对我来说有效（考虑到您正在使用 wildfly，则使用了 resteasy 指南）： https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-RESTEasy-2.X-Project-Setup-1.5

请注意，这只提供给您 swagger 文件，要使用它构建 swagger gui，您需要使用 swagger-ui 包。

- Shai Rippel

Answer 2

Swagger 会生成一个 HTML 页面，只要你的后端服务器在运行，它就可以被访问到。

尝试一下 /api/index.html

- Sedky A

---

无论是 /api/index.html 还是 /api/documentation/index.html 都没有指向任何有效的网站，服务器只会返回 404 错误。 - Alblaka