2009-11-30 57 views
2

爲了發佈一個記錄良好的應用程序,我正在尋找一種很好的方式來爲我的Grails應用程序用戶描述一個REST API。Grails REST XML API定義

我知道REST調用應該足夠簡單,可以用例子來描述,但它不夠正式。

我已經花了幾個尋求通過其他Grails用戶提出瞭解決小時,但沒有找到,除了建議很好地解決了使用WADL或WSDL 2.0

This看起來像一個很好的方向,但在Grails中必須有一個簡單的方法來完成它。

我很欣賞一些基於我的模型對象生成REST API的過程的指導,最好能夠過濾或控制暴露的字段,另外還有一個很好的圖形呈現方式(類似於XSD Eclipse插件)

謝謝! Guy

回答

1

我建議避免WADL或WSDL API文檔,你可以看到這個問題,我解釋了我的理由:Why the slow WADL uptake

WADL或WSDL通常用於自動客戶端代碼生成,它們不是人類可讀的文檔。我不認爲WADL或WSDL對用戶來說很有用,以便弄清楚如何正確使用資源。

我喜歡好老的HTML文檔,例如我喜歡的方式twitter記錄了他們的API

如果硬要將自動生成資源文件,我可以在ATOM service document推薦的。許多REST框架可以基於資源註釋自動生成它。 (例如Apache Wink)

+0

謝謝,爲自動人類可讀的客戶端文檔我挖了一點,發現http://enunciate.codehaus.org/爲Java,我想知道是否有一個等效的工具grails – 2009-12-06 14:39:50

+0

檢查下面開始http://enunciate.codehaus.org/getting_started.html和示例http://enunciate.codehaus.org/wannabecool/step1/index.html – 2009-12-06 14:50:08

+0

您的鏈接到twitter文檔已損壞。你能更新嗎? – Randyaa 2014-08-08 20:18:32