为cxf服务加上wadl描述信息

本文介绍如何使用cxf-rt-rs-service-description包为CXF REST服务自动生成WADL描述文档。通过简单配置,即可在服务启动后通过HTTP访问获取到详细的接口文档。

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

为cxf服务加上wadl描述信息


我们在开发cxf rest服务的时候,往往需要为每个服务添加描述文档,以前我们可能是将描述文档用word或者excel记录,现在介绍一种通过cxf-rt-rs-service-description自动生成wadl描述文档的方法。

1. 首先我们在项目中引入cxf-rt-rs-service-description包,通过maven方式构建

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-rs-service-description</artifactId>
  <version>3.0.0-milestone1</version>
</dependency>

2. 在服务中添加描述信息

@GET
  @Path("/reses/{resId}/{userId}")
  @Produces(MediaType.APPLICATION_JSON)
  @Description(value = "展示资源详情", target = DocTarget.METHOD)
  public ReturnMsg<ResourceDTO> showRes(@PathParam("resId") String resId, @PathParam("userId") String userId);


3. 启动服务,访问http://192.9.8.8:9080/reslib/api/?_wadl出现下面内容表示成功配置。



参考文档:http://cxf.apache.org/docs/jaxrs-services-description.html#JAXRSServicesDescription-WADLAutoGenerationatRuntime


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值