Swagger实现以退出RESTAPI

Question

我正在尝试实现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的正确方向吗？ 谢谢。

Answer 1

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

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

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