努力提供一个记录良好的应用程序，我正在寻找一种为Grails Application用户描述REST API的好方法。

我知道REST调用应该足够简单，可以通过示例进行描述，但是感觉不够正式。

我已经花了几个小时寻找其他Grails用户建议的解决方案，但是除了建议使用WADL或WSDL 2.0之外，没有找到整洁的解决方案

This看起来是一个很好的方向，但是在Grails中必须有一种简单的方法来实现。

我希望能对基于我的模型对象生成REST API的过程提供一些指导，最好具有过滤或控制公开字段的能力，以及一种很好的图形化方式来展示它(类似于XSD Eclipse插件)

谢谢!
盖伊

请您参考如下方法:

我建议避免使用API​​文档的WADL或WSDL，您可以在我解释我的原因的地方看到这个问题:Why the slow WADL uptake。

WADL或WSDL通常用于自动生成客户端代码，它们不是人类可读的文档。我认为WADL或WSDL对于用户弄清楚如何正确使用资源不是很有用。

我喜欢旧的html文档，例如，我喜欢twitter记录其API的方式

如果您坚持要自动生成资源文档，我可以推荐ATOM service document。许多REST框架都可以根据资源注释自动生成它。 (例如Apache Wink)