生成並發布基於Ruby的REST API文檔

Question

現在使用什么酷孩子來輕松解析/生成/發布REST API？ 我看了一下Swagger它看起來不錯，但從我的觀點來看，它不適合Ruby。 也許我錯了，我錯過了什么，幫助將不勝感激。

Answer 1

聽起來你還沒有API？ 如果是這種情況，這就是我推薦的方法。

• 使用swagger-specification為API創建接口 。 您無需使用服務器即可完成此操作， 請參閱此處 。

• 使用swagger-ui驗證接口。 這允許您查看已定義的所有端點（仍然沒有編碼，除了json文件！）

• 獲得所需的界面后，使用swagger-codegen構建服務器的存根版本。 目前有更多的nodejs和scalatra模板。 制作新的服務器生成器只需要創建/修改一些胡子模板。

• 您還可以使用swagger-codegen生成客戶端。

這樣做的好處在於您可以對API進行界面驅動的開發。 構建接口並填充空白。 管道為您完成。

Answer 2

我們剛剛開始玩apipie 。 到目前為止似乎很整潔。

Answer 3

Swagger可以與ruby一起用作客戶端，從Swagger兼容服務器自動生成客戶端庫https://github.com/wordnik/swagger-codegen

如果您使用RoR比我認為您應該查看https://github.com/elc/rapi_doc ，但它不容易使用。

Answer 4

請查看ApiDoco gem（ https://github.com/72pulses/apidoco/ ）獲取文檔。 它非常易於設置並具有良好的用戶體驗。