Ruby on rails 什么是生成简单API文档的ruby gem？_Ruby On Rails_Ruby_Rest_Api_Ruby On Rails 4

Ruby on rails 什么是生成简单API文档的ruby gem？

ruby-on-rails ruby rest api ruby-on-rails-4

Ruby on rails 什么是生成简单API文档的ruby gem？,ruby-on-rails,ruby,rest,api,ruby-on-rails-4,Ruby On Rails,Ruby,Rest,Api,Ruby On Rails 4,是否有任何简单的ruby gems能够：基于路由和API控制器操作上方的注释动态生成API文档。我希望在代码中为新开发人员提供文档，并且我不希望只为API文档维护单独的视图在应用程序中的单独路径下显示API文档网站。我不想为了公开api文档而运行单独的api文档服务器显示自定义注释。如果我想写一个API端点的详细解释。因此，我不想要只显示API端点和请求/响应的文档指定JSON中的请求和响应示例。包括为各种故障条件指定多个响应示例（额外）解释文件注释中的降价（额外）以各种语言生成并显

是否有任何简单的ruby gems能够：

基于路由和API控制器操作上方的注释动态生成API文档。我希望在代码中为新开发人员提供文档，并且我不希望只为API文档维护单独的视图

在应用程序中的单独路径下显示API文档网站。我不想为了公开api文档而运行单独的api文档服务器

显示自定义注释。如果我想写一个API端点的详细解释。因此，我不想要只显示API端点和请求/响应的文档

指定JSON中的请求和响应示例。包括为各种故障条件指定多个响应示例

（额外）解释文件注释中的降价

（额外）以各种语言生成并显示用于请求每个API端点的代码，如Ruby、Swift

（额外）通过API文档网站针对API运行实际请求

PS：这是一个RESTAPI，但是如果它在实践中有任何不同，那么使用一些自定义路由。我正在使用Rails。

我假设您正在使用Rails（从问题中的标签）

我已经使用它为我的RAILS后端服务创建了文档。这篇文章很好地涵盖了您的前4点。他们声称他们也支持标记语言。我还没有试过。

我假设您正在使用Rails（从问题中的标签）

我已经使用它为我的RAILS后端服务创建了文档。这篇文章很好地涵盖了您的前4点。他们声称他们也支持标记语言。我没有试过。

我一直喜欢使用

swagger是否需要使用单独的api文档服务器？它不需要。我只在C#项目中使用过它，但我相信这是一个相对简单的设置，添加一个gem并运行install生成器。然后，您所要做的就是转到

localhost:3000/swagger

。查看更多详细信息。好的，谢谢。我发现它也可以在Rails中完成。使用swagger是否需要使用单独的api文档服务器？它不需要。我只在C#项目中使用过它，但我相信这是一个相对简单的设置，添加一个gem并运行install生成器。然后，您所要做的就是转到

localhost:3000/swagger

。查看更多详细信息。好的，谢谢。我发现它也可以在Rails中完成。使用