如何让Enunciate将我的数据类型显示为结构化JSON (而不是“自定义”)？

Question

我有一个简单的服务，它回显包装在JSON对象中的ID参数：

@Path("job")
public class JobResource {

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    @Path("{id}")
    public Job readById(@PathParam("id") long id) {
        Job j = new Job();
        j.id = id;
        return j;
    }

}

返回值的Job类声明为：

public class Job {
    public long id;
}

使用Enunciate生成的文档将服务的数据类型显示为"custom“。有没有可能对返回类型进行更详细的解释，例如JSON表示？

Answer 1

如果您将返回类型更改为javax.ws.rs.core.Response，那么文档应该将数据类型显示为JSON。

您需要稍微修改您的方法，如下所示：

...
return Response.status(Status.OK).entity(j).build();

Answer 2

向作业类添加注记

@javax.xml.bind.annotation.XmlRootElement

如果没有这个注解，讲述者将把DTO显示为“自定义”或“文件”。