生成和发布基于REST API的REST API文档

什么是酷时尚孩子使用现在轻松解析/生成/发布REST API？我看了一下Swagger，看起来不错，但从我的角度来看，它不适合Ruby。也许我只是错了，我错过了什么，帮助将不胜感激。生成和发布基于REST API的REST API文档

来源

2012-04-23 jpemberthy

看起来不错，但它似乎也需要很多工作来设置 – 2012-04-23 22:32:10

确实，它看起来很棒，但它有很多我想避免的依赖关系。 – jpemberthy 2012-04-23 22:35:54

听起来像你还没有API呢？如果是这样的话，这是我推荐的方法。

通过使用swagger-specification创建用于API的接口。您可以在不使用服务器的情况下执行此操作，see here。
使用swagger-ui验证接口。这允许你看到你定义的所有端点（仍然没有编码，除了json文件！）
一旦你有一个你想要的接口，使用swagger-codegen来构建你的一个残缺版本服务器。当前有更多的模板可用于nodejs和scalatra。制作新的服务器生成器只需创建/修改一些胡须模板。
你也可以用swagger-codegen生成你的客户端。

这样做的好处在于您可以对API进行接口驱动的开发。构建接口并填写空白。管道是为你完成的。

来源

2012-08-30 21:51:00 fehguy

原型ruby支持现在可用（注意！更改将会使更多ruby-ish）：https：// github .com/wordnik/swagger-codegen/tree/master/samples/server-generator/sinatra – fehguy 2012-09-07 21:05:58

扬鞭可以用红宝石作为客户端如果您使用的回报率比我想你应该看看https://github.com/elc/rapi_doc自动生成从符合扬鞭服务器https://github.com/wordnik/swagger-codegen

客户端库，但并不好用。

来源

2012-04-24 08:22:49 Fivell

嘿，谢谢你的回答，好吧，我想我会试一试'rapi_doc'。它看起来并不像Swagger那么性感，但至少它的设置更简单。 – jpemberthy 2012-04-24 13:45:58

rapi_doc链接已损坏。我发现它分叉在各个地方，例如https://github.com/phuc/rapi_doc看起来它自2008年以来并没有真正维持，尽管 – 2014-11-27 16:59:22

我们刚刚开始为此玩apipie。到目前为止似乎很整齐。

来源

2012-09-28 02:50:44

谢谢，看起来很有希望我会在未来的项目中记住这一点。当我发布这个问题时，我正在谈论的应用程序已经在使用swagger了。 – jpemberthy 2012-09-28 16:15:41

请看看ApiDoco宝石（https://github.com/72pulses/apidoco/）的文档。这是非常容易安装，并有良好的用户体验。

来源

2017-04-12 04:55:28 sufinsha

生成和发布基于REST API的REST API文档

回答

相关问题