api_docs:在 Rails 3 中使用集成测试生成 API 文档

时间:2024-07-06 15:15:09
【文件属性】:

文件名称:api_docs:在 Rails 3 中使用集成测试生成 API 文档

文件大小:210KB

文件格式:ZIP

更新时间:2024-07-06 15:15:09

Ruby

API 文档 一种工具,可帮助您使用 Rails 中的集成测试为 API 生成文档。 安装 将 gem 定义添加到您的 Gemfile 并bundle install : gem 'api_docs' 要访问生成的文档,请将其挂载到routes.rb的路径,如下所示: mount ApiDocs :: Engine => '/api-docs' 您可能还想将 js/css 添加到您的资产管道清单中: require api_docs 文档视图与 css 和 js 库一起使用。 生成 Api 文档 文档会从您创建的用于测试 api 控制器的测试自动生成到 yaml 文件中。 首先,让我们通过运行rails g integration_test users创建集成测试。 这将创建一个文件供您使用。 这是我们可以做的一个简单的测试: class UsersTest < Act


【文件预览】:
api_docs-master
----config()
--------routes.rb(70B)
----api_docs.gemspec(699B)
----Rakefile(197B)
----test()
--------test_helper.rb(328B)
--------docs_controller_test.rb(270B)
--------dummy()
--------api_docs_test.rb(522B)
--------test_helper_test.rb(5KB)
----LICENSE(1KB)
----app()
--------assets()
--------controllers()
--------views()
----Gemfile(37B)
----VERSION(5B)
----doc()
--------screenshot.png(137KB)
----.gitignore(122B)
----lib()
--------api_docs.rb(333B)
--------tasks()
--------api_docs()
----README.md(3KB)
----script()
--------rails(317B)

网友评论