在Grails中使用聲明

Question

我以RESTful方式創建Web API。 Grails當然對創建REST Web服務有很好的支持。 Enunciate聲稱在API部分提供幫助，其中諸如文檔，客戶端庫等是重要的。

這篇文章的目的是邀請關於在Grails上使用Enunciate的經驗，或者關於如何完成的想法。

有使用它們在一起的兩個主要問題：

1. 闡明工作與JAX-RS，而不是Grails的本機實現REST的。幸運的是，有一個JAX-RS插件可用，但我不確定Enunciate是否能夠使用它。

2. Grails領域類是在Groovy，同時闡明工作與Java 源代碼（example）。

Answer 1

闡明與Java源代碼和Java編譯的字節碼一起工作。但是，如果您沒有Java源代碼，Enunciate將無法從JavaDocs中提取內容以增強其生成的文檔。鑑於此，理論上應該將Enunciate應用於已編譯的Groovy字節碼，但您的文檔不會太豐富，因爲Enunciate將無法查看JavaDoc文檔。我在理論上說，因爲我沒有任何親身經歷，也不知道如何去痛。

在ENUNCIATE-356有一個未解決的問題來調查這種複雜性。請注意，ENUNCIATE-356取決於ENUNCIATE-584，這可能會在我們從使用APT（在Java 5中引入Java 5，在Java 7中棄用）轉到Javac工具（在Java 6中引入）的過程中由ENUNCIATE-585驅動，這可能會很快引起更多的牽引力。瞭解Javac工具是否支持Java以外的語言會很有趣，在這種情況下，我們可以免費獲得Groovy支持。