【文件属性】:
文件名称:rspec_api_documentation:从RSpec自动生成API文档
文件大小:166KB
文件格式:ZIP
更新时间:2021-01-30 13:50:26
ruby api rspec APIRuby
RSpec API文档生成器
为您的Rails API生成漂亮的API文档。
检出一个。
变化
请参阅Wiki以获取最新。
安装
将rspec_api_documentation添加到您的Gemfile
gem 'rspec_api_documentation'
捆绑!
$ bundle install
设置规格。
$ mkdir spec/acceptance
$ vim spec/acceptance/orders_spec.rb
require 'rails_helper'
require 'rspec_api_documentation/dsl'
resource "Orders" do
get "/orders" do
example "Listing orders" do
do_request
expect ( status ) . to eq 200
end
end
end
生成文档!
$ rake docs:generate
$ open doc/api/index.html
观看者
考虑添加查看器以增强生成的