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

时间:2016-02-29 09:00:07

标签: json rest grails-3.0

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

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

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

1 个答案:

答案 0 :(得分:2)

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

https://github.com/rahulsom/swaggydoc

您可以从问题中看出,有些人已成功使用它来使用3.x,但与任何开源项目一样,您的millage可能会有所不同。

https://github.com/rahulsom/swaggydoc/issues