现有 REST API 的 Swagger 实现答案

【问题标题】：Swagger implementation for exiting RESTAPI现有 REST API 的 Swagger 实现
【发布时间】：2015-08-20 09:01:12
【问题描述】：

我正在尝试实现 Swagger API 来为我的 Rest API 生成 API 文档。我在 swagger.io 网站上搜索了 Swagger 配置入门，但是未能生成 API。

这是我在 pom.xml 中的依赖项

<dependency>
     <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-jaxrs</artifactId>
        <version>1.5.0</version>
</dependency>

和applicationContext.xml中的bean类：

<bean id="beanConfig" class="io.swagger.jaxrs.config.BeanConfig">
    <property name="title" value="Swagger Sample App"/>
    <property name="version" value="1.0.0" />
    <property name="schemes" value="http" />
    <property name="host" value="localhost:8002" />
    <property name="basePath" value="/api"/>
    <property name="resourcePackage" value="io.swagger.resources"/>
    <property name="scan" value="true"/>
</bean>

还有我的 web.xml

<servlet>
        <servlet-name>Jersey2Config</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</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
</servlet>

在这里，在 web.xml 中，我在 Jersey2Config 中遇到错误，因为它正在寻找 servlet 映射。在 Swagger.io 中，提到不需要 servlet 映射。任何人都可以指出我创建 Swagger API 的正确方向吗？谢谢。

【问题讨论】：

标签： java api swagger

【解决方案1】：

如果您使用的是 DefaultJaxrsConfig，则不需要使用 BeanConfig。这用于没有 web.xml 的编程配置。

您可以摆脱其中一个，但不能同时摆脱两者。使用 web.xml 可能是最简单的，请参见以下示例：

https://github.com/swagger-api/swagger-samples/tree/master/java/java-jersey-jaxrs

【讨论】：