发音可以采用Java接口作为数据类型吗？

Question

我想使用 Enarticulateciate 自动生成我的 REST API 的文档。

JAX-RS注释代码如下：

@POST
@Produces({MediaType.APPLICATION_JSON, MediaType.TEXT_XML})
@Consumes({MediaType.APPLICATION_JSON, MediaType.TEXT_XML})
public IAuthentication login(CLogin aLogin) throws XException {
    return this.pManager.authenticate(aLogin);
}

< code>IAuthentication是一个接口，它必须保持不变。这是因为我使用了注入，我无法预测方法< code>authenticate()返回的确切类型。然而，< code>CLogin是一个类，这是可以的，因为它是方法< code>authenticate()接受的类型的专门化。

现在我的问题是，只有请求主体是Enunciate生成的文档中的文档，而不是响应主体。在寻找潜在的数据类型时，Enunciate似乎忽略了Java接口，并显示以下消息：

[调试][ENUNCIATE] com.example.IAuthentication 不是潜在的 Jackson 类型，因为它不是一个类或枚举。

我的接口使用JAXB注释进行注释。它们可以从源路径访问。

@XmlRootElement
public interface IAuthentication {
    /* methods signatures */
}

有没有办法告诉 Enarticulateciate Java 接口作为数据类型是可以的，必须考虑在内。

补遗

此方法的JSON输出的真实示例：

{
    "token": "imec51lpb72lgsdrb0ftvfomt3",
    "auth_key": ""
}

Answer 1

根据@stoic火焰对这个问题的回答，2.7版的发音似乎不支持Java接口作为数据类型。

我求助于使用JavaDoc标签< code>@returnWrapped。另一个选项是发音特定的注释< code>@TypeHint。JavaDoc标签使我免受外部运行时依赖。

编辑：Enunciate版本2.9.0现在支持记录接口类型。