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