使用io.swagger集成swagger与cxf

最新推荐文章于 2025-03-04 22:48:54 发布

wqlpz23045

最新推荐文章于 2025-03-04 22:48:54 发布

阅读量3.6k

点赞数

文章标签： spring cxf swagger

本文链接：https://blog.youkuaiyun.com/wqlpz23045/article/details/83315308

版权

本文介绍了如何将io.swagger（版本1.5.2）集成到cxf（2.7.18）、spring（3.2.7.RELEASE）和struts2（2.3.36）的项目中，提供了详细的配置步骤和可能出现的错误解决方案。参考了官方示例文档，并指出了针对cxf-3.x版本的不同集成策略。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

io.swagger(1.5.2)集成cxf(2.7.18) spring(3.2.7.RELEASE) struts2(2.3.36)

一：参考文档：

https://github.com/swagger-api/swagger-samples/blob/master/java/java-jaxrs-cxf/src/main/webapp/index.html

https://github.com/swagger-api/swagger-samples/tree/master/java/java-resteasy-spring/src/main/webapp/WEB-INF

https://github.com/swagger-api/swagger-ui/tree/2.x/dist

二：配置

pom.xml

		<!-- swagger -->
		<dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-jaxrs</artifactId>
            <version>1.5.2</version>
            <exclusions>  
	            <exclusion>  
	                <groupId>javax.validation</groupId>
				    <artifactId>validation-api</artifactId>
	            </exclusion>
        	</exclusions> 
        </dependency>

复制https://github.com/swagger-api/swagger-ui/tree/2.x/dist的页面到项目,并根据配置修改swagger.index.html的url

security.xml增加

<http pattern="/**/*.json" security="none" />
cxf-service.xml增加

	<bean id="swaggerListingResource" class="io.swagger.jaxrs.listing.ApiListingResource"/>
	<bean id="swaggerWriter" class="io.swagger.jaxrs.listing.SwaggerSerializers"/>
	
	<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:8080" />
        <property name="basePath" value="xxxx"/>
        <property name="resourcePackage" value="com.x.x.x.x"/>
        <property name="scan" value="true"/>
    </bean>

	<jaxrs:server address="/swagger" id="swaggerApi">
		<jaxrs:serviceBeans>
			<ref bean="swaggerListingResource"></ref>
		</jaxrs:serviceBeans>
        <jaxrs:providers>
			<ref bean="swaggerWriter" />
		</jaxrs:providers>
	</jaxrs:server>

其中<property name="resourcePackage" value="com.x.x.x.x"/>是要提供服务接口的服务，使用@Path,@Api,@ApiOperation等注解

三：错误：

使用1.5.0报错

Failed to scan JAR [file:/Users/wangql/deploy/gppmm/ppmm/WEB-INF/lib/jackson-dataformat-xml-2.4.2.jar] from WEB-INF/lib

java.util.zip.ZipException: error in opening zip file

使用1.5.9报错

javax/validation/constraints/Size找不到

四：如果是cxf-3.x，可以参考

https://github.com/apache/cxf/tree/3.0.x-fixes/distribution/src/main/release/samples/jax_rs。

http://cxf.apache.org/docs/swagger2feature.htm

估计使用2.x的配置方式也可以实现。具体没有测试过