다중 모듈 Maven 프로젝트에서 Enunciate 사용

Question

Enunciate를 사용하여 다중 모듈 Maven 프로젝트 내의 RestEasy 서비스에 대한 설명서를 생성합니다. 응답 개체 속성에 대한 설명을 얻으려고 할 때 문서 생성에 몇 가지 문제가 있습니다. 예를 들어

, 내 서비스는 다음과 같이 정의 된 경우 : 문서가 더 atribute 설명을 생성하지

@GET 
@Path("access/account") 
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) 
Account getAccount(@Context HttpServletRequest hsr, @Context UriInfo info) throws RestApiException; 

가 생성됩니다.

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 모듈에 있습니다.

응답 객체 을 EJB 모듈에도 정의하면 설명서가 완벽하므로 (설명도 생성되기 때문에) 문제의 원인은 분명히 다중 모듈 Maven 프로젝트입니다.

이유도이 솔루션은 여기에 설명되어 있습니다 : 나는 아직도 정확히 무엇을 해야할지하지 않는 모든 것과 내 문제를 해결하기 위해 내부에 다른 리딩 (EJB 및 UTIL)를 설정에도 불구하고 https://github.com/stoicflame/enunciate/wiki/Multi-Module-Projects-%28Version-1%29

.

도움이 필요합니다.

Answer 1

Multi-Module Projects에 설명 된대로 Account 클래스를 "가져 오기"했습니까?

<enunciate ...> 
    <api-import pattern="com.mycompany.Account" /> 
    <api-import pattern="com.mycompany.*" /> 
    ... 
</enunciate> 

Answer 2

문제가 해결되었습니다. 에

내가했다 : 라이언 말했듯이

이

1. 이 클래스를 가져
모든 응답 객체가
2. 추가 설명을 위치한 UTIL 클래스의 pom.xml 파일에서
3. 추가 받는다는 - 소스 플러그인 참조 클래스의 메소드를 얻을

결과는 다음과 같습니다

JSON 
property type description 
idProfile int  Description B. 
idLanguage int  Description A. 
idRegion int  Description E. 
userType string Description D.