簡體   English   中英

如何使用Grails3為JSON API創建文檔

[英]How to create documentation for a JSON API using Grails3

我們將使用Grails控制器創建一個暴露REST JSON API的Grails 3項目。

有沒有辦法自動生成REST API的API文檔,使用注釋或任何其他可管理的表單來跟上我們的開發? 換句話說,我們需要一種方法來自動生成API文檔,與控制器操作和參數/返回對象的更改同步。

我們查看了Swagger和一些類似的項目,但我們無法找到在Grails 3 REST API開發過程中集成文檔工作流的方法。 到目前為止,我們發現了那些可以幫助我們的非常有前景的項目,但是我們還沒有找到任何方法來集成到Grails 3:

這個庫看起來是Grails 3最受歡迎的選擇:

https://github.com/rahulsom/swaggydoc

您可以從問題中看出,有些人已成功使用它來使用3.x,但與任何開源項目一樣,您的millage可能會有所不同。

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

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM