2

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

这篇文章的目的是邀请使用 Enunciate with Grails 的经验,或关于如何做到这一点的想法。

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

  1. Enunciate 与 JAX-RS 一起工作,而不是 Grails 对 REST 的本机实现。谢天谢地,有一个可用的 JAX-RS 插件,但不确定 Enunciate 是否能够使用它。

  2. Grails 域类在 Groovy 中,而 Enunciate 使用 Java 源代码(示例)。

4

1 回答 1

1

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

ENUNCIATE-356有一个未解决的问题来调查这种复杂性。请注意,ENUNCIATE-356依赖于ENUNCIATE-584,它可能很快就会获得更多牵引力,由ENUNCIATE-585驱动,因为我们从使用 APT(在 Java 5 中引入,在 Java 7 中不推荐使用)转移到 Javac 工具(在 Java 中引入6)。想知道 Javac 工具是否支持 Java 以外的语言会很有趣,在这种情况下,我们将免费获得 Groovy 支持。

于 2011-08-04T13:44:45.020 回答