RoR:Swagger没有更新api-docs

时间:2014-12-04 09:36:05

标签: ruby-on-rails api documentation swagger-ui

我已将swagger-ui_rails集成到我现有的Rails应用中。我在我的应用程序中添加了一个新模型“ Book ”,现在想要更新我的 api-docs 。我怎么能这样做?

我正在尝试rake swagger:docs,但这并没有改变任何事情。 此外, app / controller / api / v1 / 目录中没有 books_controller ,其中已存在其他控制器。

我是Rails和Swagger的新手,所以如果我遗漏了一些基本的东西,请忽略。

1 个答案:

答案 0 :(得分:1)

由于您提到您为API定义控制器,我假设您有一个home-brewn API。这没关系,但是你必须手动生成swagger文档。没关系,但不是我可以帮助你的东西。

但是,如果您为api使用grape,则可以使用grape-swagger gem。 Grape将为您替换API的控制器。它更像是描述API的DSL,其中包含要执行的代码。 grape-swagger gem将自动解析葡萄定义并将其转换为swagger文档。

它也提供了额外的选项,比如Markdown中的写入描述。 grape-swagger宝石很棒:)

我喜欢这种方法,我构建了一个普通的rails应用程序,并使用grape来提供API部分。无论如何,UI和API的控制器都会有所不同。