生成REST API的Swagger UI文档

Question

我使用Java中的JAX-RS/Jersey开发了我的REST API.我想为它转换为/生成基于Swagger的UI文档.任何人都可以告诉我精确/步骤简单的方法如何这样做？对不起,但他们网站上的步骤对我来说有点模糊.

Answer 1

有几种方法可以将swagger-core与您的应用程序集成,但根据您的描述,我只需按照https://github.com/swagger-api/swagger-core/wiki/Swagger所述的Wiki页面进行操作.-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取决于你使用的泽西版.

这些页面还链接到一组样本,您可以使用这些样本进行参考,并了解它们的工作原理.他们还将swagger-ui直接插入其中,这样您就可以看到一整套互动.

Answer 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 clean install创建了swagger json.据我所知,它不需要对web.xml等进行任何操作,因为它通过字节码分析来完成.

来源:亚当边博客条目与他在airhacks会话的一个演示

奖励:插件创建者解释使用情况的9分钟视频