JAXB definitions in dependent jar are not taken into account

[fcav1973]

In seems that when a GET method returns a JAXB annotated object, the generated swagger.json does not contains the correct description es:

... @GET @Path("/pap/{repoId}") @Produces({ APPLICATION_JSON, APPLICATION_XML }) public PolicyRepositoryInfo getPap(@PathParam("repoId") String repoId) throws SystemException, IllegalArgumentException; ...

where PolicyRepositoryInfo resides in a declared (compile) dependency jar

turns into:

... "/authorization/pap":{ "get":{ "consumes":[ ], "produces":[ "application/json", "application/xml" ], "parameters":[ ], "responses":{ "204":{ "description":"No Content", "headers":{ } } }, "tags":[ "authorization" ] }, }, ...
The same PolicyRepositoryInfo object is correctly referred when used for post requests

"post":{ "consumes":[ "application/json", "application/xml" ], "produces":[ "application/json", "application/xml" ], "parameters":[ { "name":"body", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/PolicyRepositoryInfo" } } ], "responses":{ "204":{ "description":"No Content", "headers":{ } } }, "tags":[ "authorization" ] }

[sdaschner]

Normally the schema should be included in the responses object, but there is just a 204 No Content response. How does your getPap method look like? Does it actually return an object which is not null?

[fcav1973]

Hi,
if it can help, the method is implemented in a separate jar, which his not included in the compiler class path (this because the plugin has been plugged in the API module, not the IMPL) so at generation time, non information, a part from declaration, is provided to plugin.
Anyway the implementation of the method can return null if the resource has not been found.

[sdaschner]

Ok, so if the implementation is not available to the Analyzer, then it won't get all needed information... That's probably why it falls back to the 204 response.

[fcav1973]

Ok, thanks. The problem is that if I move the plugin execution on the implementation project, the API jar (which is a compile dependency and which has all methods and dto definitions) seems not to be taken into account, resulting in an empty output.

INFO] Generating resources at /home/fcavarretta/workspaces_new/a3server/a3server-parent-bnp-fix/a3server-rest/target/jaxrs-analyzer/swagger.json [INFO] Empty JAX-RS analysis result, omitting output
It seems like that only the current project is taken into account for generation and not the dependent jars.
Could it be a possible solution to add to plugin configuration the list of artifact (dependencies) to be included ?

[abstratt]

@sdaschner Any workarounds for people where DTOs and resources are defined in different Maven artifacts?

[fcav1973]

After some investigations, I found that the problem is due to the fact that annotations have been put on an interface and not into the concrete class.
The following class can be used to reproduce the problem:

package com.primeur.test.resources;

import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
import static javax.ws.rs.core.MediaType.APPLICATION_XML;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;

@Path("/basepath")
public interface RestService {
	@GET
	@Path("/value")
	@Produces({ APPLICATION_JSON, APPLICATION_XML })
	public int getValue();

	@GET
	@Path("/strvalue")
	@Produces({ APPLICATION_JSON, APPLICATION_XML })
	public String getStrValue();
}

The problem is due to jaxrs-analizer behavior and non strictly to the maven plugin. For this reason I filed this issue: sdaschner/jaxrs-analyzer#117