如何使用 Grails3 为 JSON API 创建文档答案

【问题标题】：How to create documentation for a JSON API using Grails3如何使用 Grails3 为 JSON API 创建文档
【发布时间】：2016-06-12 05:56:54
【问题描述】：

我们将创建一个使用 Grails 控制器公开 REST JSON API 的 Grails 3 项目。

有没有办法自动为 REST API 生成一个 API 文档，使用注释，或任何其他可管理的形式来跟上我们的发展？换句话说，我们需要一种方法来自动生成 API 文档，与控制器操作和参数/返回对象的更改同步。

我们查看了 Swagger 和一些类似的项目，但我们无法找到将文档工作流集成到 Grails 3 REST API 开发过程中的方法。到目前为止，我们发现了那些非常有前途的项目可以帮助我们，但我们还没有找到任何集成到 Grails 3 的方法：

【问题讨论】：

【解决方案1】：

这个库看起来是 Grails 3 最流行的选择：

您可以从问题中看到，有些人已经成功地将它与 3.x 一起使用，但与任何开源项目一样，您的选择可能会有所不同。

【讨论】：