使用Grails的Enunciate

Question

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

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

有两个主要问题在一起使用：

1. Enunciate适用于JAX-RS，而不是Grails的REST本机实现。值得庆幸的是，有一个JAX-RS插件可用，但我不确定Enunciate是否能够使用它。

2. Grails域类在Groovy中，而Enunciate在Java中使用 源代码（example）。

Answer 1

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

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