api - 在 Grails 中使用 Enunciate

Question

我正在以 RESTful 方式创建 Web API。 Grails 当然对创建 REST web 服务有很好的支持。 Enunciate声称在 API 部分有所帮助，其中文档、客户端库等很重要。

这篇文章的目的是邀请使用 Enunciate 和 Grails 的经验，或者如何做到这一点的想法。

将它们一起使用有两个主要问题:

Enunciate 使用 JAX-RS，而不是 Grails 对 REST 的 native 实现。幸运的是，有一个 JAX-RS 插件可用，但我不确定 Enunciate 是否能够使用它。

Grails 域类使用 Groovy，而 Enunciate 使用 Java
源代码 ( example )。

Answer 1

Enunciate 使用 Java 源代码和 Java 编译的字节码来完成它的工作。但是，如果您没有 Java 源代码，Enunciate 将无法从您的 JavaDocs 中提取内容以增强其生成的文档。鉴于此，应该(理论上)有一种方法可以将 Enunciate 应用于已编译的 Groovy 字节码，但是您的文档不会那么丰富，因为 Enunciate 将无法看到您的 JavaDoc 文档。我这么说是理论上的，因为我没有任何个人经验，也不知道实现起来有多痛苦。

在 ENUNCIATE-356 有一个 Unresolved 问题调查这种复杂性。请注意 ENUNCIATE-356取决于 ENUNCIATE-584 ，它可能很快会获得更多牵引力，由 ENUNCIATE-585 驱动随着我们从使用 APT(在 Java 5 中引入，在 Java 7 中弃用)转向 Javac 工具(在 Java 6 中引入)。了解 Javac 工具是否支持 Java 以外的语言会很有趣，在这种情况下，我们将免费获得 Groovy 支持。