为 REST API 生成 Swagger UI 文档

java swagger swagger-ui

2022-09-01 12:15:37

我使用Java中的JAX-RS / Jersey开发了我的REST API。我想为它转换/生成基于Swagger的UI文档。任何人都可以以简单的方式告诉我如何做到这一点的精确/步骤吗？我很抱歉，但是，他们网站上给出的步骤对我来说有点模糊。

答案 1

有几种方法可以将swagger-core与您的应用程序集成，但根据您的描述，我只是按照 https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-1.X-Project-Setup-1.5 或 https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5 描述的wiki页面进行操作，具体取决于您使用的泽西岛版本。

这些页面还链接到一组示例，您可以将其用作参考并查看它们的工作原理。它们还直接将swagger-ui拉入其中，以便您可以看到完整的交互集。

答案 2

我知道最简单的方法是使用JAXRS Analyzer maven插件。可以在GitHub上找到

<plugin>
<groupId>com.sebastian-daschner</groupId>
<artifactId>jaxrs-analyzer-maven-plugin</artifactId>
<version>0.4</version>
<executions>
    <execution>
        <goals>
            <goal>analyze-jaxrs</goal>
        </goals>
        <configuration>
            <!-- Available backends are plaintext (default), swagger and asciidoc -->
            <backend>plaintext</backend>
            <!-- Domain of the deployed project, defaults to example.com -->
            <deployedDomain>example.com</deployedDomain>
        </configuration>
    </execution>
</executions>

这将通过 mvn 全新安装为您创建 swagger json。据我所知，它不需要对Web.xml等进行任何操作，因为它通过字节码分析来做到这一点。

资料来源：Adam Bien博客条目和他在其中一个airhacks会议中的演示

奖励：插件创建者的9分钟视频，解释用法