记录Grape API

Question

我正在构建一个Grape API，我的大部分请求都是基于JSON有效负载而不是参数。我听说Swagger不适合这方面。如果有人能够向我指出如何有效地记录API，我将不胜感激。

Answer 1

我开始使用葡萄与招摇，但我第一次使用https://github.com/BrandyMint/grape-swagger-rails宝石。但是他们正在使用旧版本的swagger（代码）。所以他们需要更改gem的一些代码。

我使用swower和bower开始了一个项目，使用了最新版本的代码。他们改进了所有代码。现在看起来不错。

我创建了一个gem的分支（https://github.com/pragmaticivan/grape-swagger-rails）。所以我对版本和配置进行了一些更改。我现在在一个项目中使用它看起来不错。 wine-swagger的最后一个版本（grape-swagger-rails的依赖）具有soem的新功能，你可以为端点的代码示例选择Markdown编译器。

我在这个项目中用bower测试了swagger-ui：https://github.com/larica/larica-api。 但是在未来我会改用叉子。它现在工作得非常好。