我正在以RESTful方式创建Web API。当然,Grails对创建REST Web服务具有良好的支持。 Enunciate声称会在API部分提供帮助,在该部分中,文档,客户端库等都很重要。
这篇文章的目的是邀请有关使用Grails进行Enunciate的经验,或有关如何实现的想法。
一起使用它们有两个主要问题:
源代码(example)。
最佳答案
Enunciate与Java源代码和Java编译字节码一起工作。但是,如果您没有Java源代码,那么Enunciate将无法从JavaDocs中提取内容以增强其生成的文档。鉴于此,(理论上)应该有一种方法可以将Enunciate应用于已编译的Groovy字节码,但是您的文档不会那么丰富,因为Enunciate无法看到您的JavaDoc文档。我说的是理论上的原因,因为我对此没有任何亲身经历,也不知道退出会带来多大的痛苦。
ENUNCIATE-356有一个未解决的问题,以研究这种复杂性。请注意,ENUNCIATE-356取决于ENUNCIATE-584,随着我们从使用APT(在Java 5中引入,在Java 7中弃用)到Javac工具(在Java 6中引入),由ENUNCIATE-585驱动,ojit_a可能会很快受到更多关注。知道Javac工具是否支持Java以外的语言会很有趣,在这种情况下,我们将免费获得Groovy支持。
关于api - 与Grails结合使用,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/6935702/