生成并发布基于Ruby的REST API文档
现在使用什么酷孩子来轻松解析/生成/发布REST API？ 我看了一下Swagger它看起来不错，但从我的观点来看，它不适合Ruby。 也许我错了，我错过了什么，帮助将不胜感激。
听起来你还没有API？ 如果是这种情况，这就是我推荐的方法。
-
使用swagger-specification为API创建一个接口 。 您无需使用服务器即可完成此操作， 请参阅此处 。
-
使用swagger-uivalidation接口。 这允许您查看已定义的所有端点（仍然没有编码，除了json文件！）
-
获得所需的界面后，使用swagger-codegen构建服务器的存根版本。 目前有更多的nodejs和scalatra模板。 创建一个新的服务器生成器只需要创建/修改一些胡子模板。
-
您还可以使用swagger-codegen生成客户端。
这样做的好处在于您可以对API进行界面驱动的开发。 构建接口并填写空白。 管道工作是为您完成的。
我们刚刚开始玩apipie 。 到目前为止似乎非常整洁。
Swagger可以与ruby一起用作客户端，从Swagger兼容服务器自动生成客户端库https://github.com/wordnik/swagger-codegen
如果您使用RoR比我认为您应该查看https://github.com/elc/rapi_doc ，但它不容易使用。
请查看ApiDoco gem（ https://github.com/72pulses/apidoco/ ）获取文档。 它非常易于设置并具有良好的用户体验。