swagger - 记录葡萄 API

Question

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

Answer 1

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

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

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

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