文件名称:dox:来自Rspec的自动化API文档
文件大小:53KB
文件格式:ZIP
更新时间:2024-04-15 10:52:46
Ruby
多克斯 自动化您的文档编写过程! Dox从Rails应用程序中的Rspec控制器/请求规范生成API文档。 它以格式格式化测试输出。 使用ReDoc渲染器将文档生成并显示为HTML。 这是一个。 安装 将此行添加到应用程序的Gemfile中: group :test do gem 'dox' , require : false end 然后执行: $ bundle 或将其自己安装为: $ gem install dox 用法 要求它 在rails_helper中要求Dox: require 'dox' 配置它 在rails_helper中设置以下可选选项: 选项 价值 描述 descriptions_location 路径名实例或全路径字符串 包含资源降价描述的文件夹。 schema_request_folder_path 路径名实例或全路径字符串 带有资源请求架构
【文件预览】:
dox-master
----.gitignore(94B)
----infinum.png(5KB)
----README.md(10KB)
----.rubocop.yml(209B)
----bin()
--------console(328B)
--------setup(131B)
----Gemfile(181B)
----.ruby-version(6B)
----CHANGES.md(2KB)
----.rspec(53B)
----dox.gemspec(2KB)
----CODE_OF_CONDUCT.md(2KB)
----spec()
--------formatters()
--------support()
--------fixtures()
--------entities()
--------config_spec.rb(522B)
--------dsl_spec.rb(2KB)
--------dox_spec.rb(96B)
--------formatter_spec.rb(7KB)
--------printers()
--------dsl()
--------util()
--------spec_helper.rb(282B)
----LICENSE.txt(1KB)
----exe()
--------dox(116B)
----.travis.yml(1KB)
----lib()
--------dox.rb(2KB)
--------dox()
----Rakefile(114B)