自助生成rails api 文档

最新推荐文章于 2022-03-12 15:51:58 发布
最新推荐文章于 2022-03-12 15:51:58 发布
阅读量926 收藏
点赞数
分类专栏： Ruby or Rails 文章标签： rails api 文档 server

自助生成rails api 文档

 

除了使用gem_server，从网上下载等方式之外，也可以通过几个简单的命令生成rails所有组件的文档

先决条件：

已经安装好rails开发环境，可以通过rails命令创建app啦

步骤：

在console依次运行：

CODE:

rails doc_app
cd doc_app
rake rails:freeze:gems
rake doc:rails成功后会在doc_app的doc目录下生成一个api目录，这里就是当前安装的rails相关组件的全部文档啦

把这个目录复制到桌面上，就可以随时访问了，至于doc_app，删除即可
wu4long
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Rails API 文档
02-02
Rails 2.0 API 文档. HTML 格式。免费下载
rails文档
zhousning的专栏
11-12 603
rails命令(rails) 创建应用程序(rails new) 适用版本 1.0.0  1.1.0  1.1.1  1.1.6  1.2.0  1.2.6  2.0.0  2.0.1  2.0.3  2.1.0  2.2.1  2.3.2  2.3.8  3.0.0  3.0.5  3.0.7  3.0.9  3.1.0  3.2.3
用Ruby on Rails实现适应各种平台的在线Office文档预览
Ahxing1985的专栏
02-01 307
前言 在许多Web应用中都需要预览文档的功能。而用户可能用不同的设备访问Web应用，可能是装有Windows系统的PC台式机，也有可能是iOS系统的iPad。一般来说，要预览的文档通常是主流的Office文档，包括.doc、.ppt、.docx、.pptx文档，也包括Adobe的.pdf文档。 因此开发一个能够在不同客户端上使用的，支持主流Office文档类型的在线文档预览系统就显得非常重要。 目...
Ruby on Rails打造企业级RESTful API项目实战我的云音乐
02-26
<img src="https://img-bss.csdn.net/201903040517183350.jpg" alt="" /><img src="https://img-bss.csdn.net/201903040517279072.jpg" alt="" /><img src="https://img-bss.csdn.net/201903040517354656.jpg" alt="" /><img src="https://img-bss.csdn.net/201903040517433920.jpg" alt="" /><img src="https://img-bss.csdn.net/201903040517524565.jpg" alt="" />
自助生成rails api 文档（转）
mathsfan的blog
07-18 173
[code]rails doc_app cd doc_app rake rails:freeze:gems rake doc:rails[/code] 成功后会在doc_app的doc目录下生成一个api目录，这里就是当前安装的rails相关组件的全部文档啦。 把这个目录复制到桌面上，就可以随时访问了，至于doc_app，删除即可。 另： 第三步换成 [code]rake ra...
Rails API文档
11-22
Ruby on Rails 是一个用于开发数据库驱动的网络应用程序的完整框架。Rails基于MVC（模型- 视图- 控制器）设计模式。从视图中的Ajax应用，到控制器中的访问请求和反馈，到封装数据库的模型，Rails 为你提供一个纯Ruby...
apidoco：Ruby on Rails API文档工具
02-06
Apidoco-Ruby on Rails API文档工具 REST API的简单文档-。 屏幕截图 安装 将此行添加到您的应用程序的Gemfile中： gem 'apidoco' 然后执行： $ bundle 将此行添加到您的路线： mount Apidoco :: Engine , at :...
rails api（文档）
04-29
在开发过程中，了解和参考Rails API文档将极大地帮助你理解和利用这个强大的框架，以构建健壮、高效的API服务。同时，熟悉相关的Gem和工具，如 grape、rabl 或 jbuilder，可以帮助你进一步定制和扩展你的API功能。
api_docs:在 Rails 3 中使用集成测试生成 API 文档
06-16
一种工具，可帮助您使用 Rails 中的集成测试为 API 生成文档。 安装 将 gem 定义添加到您的 Gemfile 并bundle install ： gem 'api_docs' 要访问生成的文档，请将其挂载到routes.rb的路径，如下所示： mount ...
本地生成Rails API文档
weixin_30646505的博客
02-21 172
#新建一rails项目 rails new dummy cd dummy # 生成文档 rake doc:rails 剩下的就是等待了。 生成的文档在dummp/doc/api 。浏览器打开index.html就可以了。 注意： Windows7下使用rake doc:rails会报错。 Invalid argu - D:/Project/dummp/doc/api/files/...
RUBY用来生成开发文档的工具
05-26
RDoc是针对Ruby源代码的文档系统。跟JavaDoc一样，RDoc可以读取原文件，分析源代码中的语法信息和注释文本，生成HTML格式的文档。和JavaDoc不同的是，即便源代码没有任何注释，RDoc也能生成相当漂亮的文档内容。在编写源程序的同时编写RDoc可以说易如反掌。 Ruby的内建库和标准库文档都是用RDoc生成的。应该可以使用ri命令来访问这些文档，不过这也取决于你安装Ruby的方式。
Rails3的ActiveRecord 查询API.doc
05-12
Rails3的ActiveRecord 查询API.doc
schemagen:通过检查Rails应用程序生成RESTful API模式，文档和客户端库
04-28
模式生成 通过检查Rails应用程序来生成RESTful API模式，文档和客户端库。 Schemagen检查Rails应用程序的路由，控制器，模型，视图，序列化器和注释，以构建描述REST API的中间对象表示形式。 一旦有了Rails API的内存表示形式，就可以使用它使用一种流行的API描述标准（例如JSON模式，RAML，Swagger等）来生成模式。 生成架构后，您可以对所选的架构使用预先存在的工具，以进一步生成API的客户端库和文档。 另外，您可以编写自己的Schemagen生成器，如果不存在预先存在的工具，或者您想做一些真正的自定义操作，这将很有用。 稳定 Schemagen目前是一种概念证明。 用它来激发灵感，但不要在生产中使用它，至少现在还没有！ 路线图 通过检查简单的Rails应用程序来获取内存中的RESTful API表示形式。 在此步骤中，Schemagen将仅
rails 入门文档
09-13
本文介绍如何开始使用 Ruby on Rails。 读完本文，你将学到： 如何安装 Rails，新建 Rails 程序，如何连接数据库； Rails 程序的基本文件结构； MVC（模型，视图，控制器）和 REST 架构的基本原理； 如何快速生成 Rails 程序骨架；
rails指南 中文版
09-13
rails指南 中文版
使用Rails制作API
代码教主
06-15 1220
如今，一种常见的做法是严重依赖API（应用程序编程接口）。 不仅像Facebook和Twitter这样的大型服务都采用了它们，而且由于客户端框架（如React，Angular等）的广泛传播，API非常受欢迎。 Ruby on Rails遵循了这一趋势，最新版本提供了一项新功能，使您可以创建仅API的应用程序。 最初，此功能打包在一个名为rails-api的单独的gem中，但是自从Rails...
使用 Rails 构建 API 实践
li_001的博客
03-25 4351
首先建立一个项目: build-an-api-rails-demo$ rails new build-an-api-rails-demo加入第一个 API resourceBaseController生成控制器:# 我们不需要生成资源文件 $ bundle exe rails g controller api/v1/base --no-assetsapp/controllers/api/v1/bas
在 Rails 中生成 PDF
m0_67788957的博客
03-12 583
能够以 pdf 格式下载数据是您在构建 Web 应用程序时会遇到的常见要求。在 Rails 中有不同的方法可以实现这一点。我们将研究用于生成 pdf 文档的两种主要方法：使用 Ruby 使用 DSL 定义和样式化文档，或者使用将 HTML 转换为 PDF 的库。 今天我们将重点介绍三种流行的宝石： 大虾（使用 DSL 方法） PDFKit（使用生成器） 邪恶的 PDF（也使用生成器）。 HTML 到 PDF 或 Ruby 生成？ 这个问题的答案通常取决于偏好和项目要..
快速生成文档注释快捷键
zhengyongbo的博客
08-10 5653
/** 然后回车效果如下/** * * @param <P> * @param <D> * @param <W> */
Rails 5更新详解：API与ActionCable的实战指南
书中详细介绍了 Rails 5 的主要特性，如 Rails API 和 ActionCable，并通过小型示例项目演示如何构建 JSON API、向页面添加实时通知以及创建单页应用程序。同时，书中还列出了所有破坏性的变化，提供了解决方案，...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值