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

How to create documentation for a JSON API using Grails3

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

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

我们研究了 Swagger 和一些类似的项目，但我们无法找到一种方法将文档工作流集成到我们的 Grails 3 REST API 开发过程中。到目前为止，我们找到了那些真正有前途的项目可以帮助我们，但我们还没有找到任何方式集成到 Grails 3:

这个库看起来是 Grails 3 最受欢迎的选择：

您可以从这些问题中看出，有些人已经成功地使用它 3.x，但是对于任何开源项目，您的成功率可能会有所不同。