首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >在多模块Maven项目中使用Enunciate

在多模块Maven项目中使用Enunciate
EN

Stack Overflow用户
提问于 2013-08-08 14:48:47
回答 2查看 1.3K关注 0票数 0

在多模块Maven项目中,我使用阐述来生成RestEasy服务的文档。当我试图获得响应对象分布的描述时,我在文档生成方面遇到了一些问题。

例如,如果我的服务定义为:

代码语言:javascript
复制
@GET
@Path("access/account")
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
Account getAccount(@Context HttpServletRequest hsr, @Context UriInfo info) throws RestApiException;

生成文档时,不生成属性描述。

代码语言:javascript
复制
name                type    description
idProfile           int     (no documentation provided)
idLanguage          int     (no documentation provided)
idRegion            int     (no documentation provided)
userType            string  (no documentation provided) 

在所有响应对象中,我只得到(没有提供文档)。一个重要的想法是,所有响应类都位于与服务不同的Maven模块中。响应类位于UTIL模块中。服务位于EJB模块中。

造成这个问题的原因肯定是多模块Maven项目,因为如果我也在EJB模块中定义了类的响应对象,那么文档是完美的(也会生成描述)。

本文描述了原因及解决方案:https://github.com/stoicflame/enunciate/wiki/Multi-Module-Projects-%28Version-1%29

尽管如此,我仍然不知道该做什么,以及在不同的poms (EJB和UTIL)中设置什么来解决我的问题。

任何帮助都会被接受。

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2013-08-08 18:28:07

那么,您是否尝试“导入”Account类,如多模块项目中所述

代码语言:javascript
复制
<enunciate ...>
  <api-import pattern="com.mycompany.Account" />
  <api-import pattern="com.mycompany.*" />
  ...
</enunciate>
票数 1
EN

Stack Overflow用户

发布于 2013-08-09 10:47:39

问题解决了!

我不得不:

  1. 像Ryan说的那样导入类
  2. 在所有响应对象所在的UTIL类的pom.xml中添加maven-source插件。
  3. 添加描述以获取引用类中的方法

结果是:

代码语言:javascript
复制
JSON
property    type    description
idProfile   int     Description B.
idLanguage  int     Description A.
idRegion    int     Description E.
userType    string  Description D.
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/18129119

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档