标签: rspec-api-documentation

使用rspec_api_documentation和apitome进行API版本控制

我们正在使用rspec_api_documentation并设法为我们目前为止的2个版本生成以下代码的文档:

RspecApiDocumentation.configure do |config|
  config.docs_dir = Rails.root.join('doc', 'api', 'all')

  config.define_group :v1 do |config|
    config.filter = :v1
    config.docs_dir = Rails.root.join('doc', 'api', 'v1')
    config.api_name = 'API V1'
  end

  config.define_group :v2 do |config|
    config.filter = :v2
    config.docs_dir = Rails.root.join('doc', 'api', 'v2')
    config.api_name = 'API V2'
  end
end
Run Code Online (Sandbox Code Playgroud)

我们正在使用apitome这些文档进行渲染,但是到目前为止,我们还没有找到为两个版本的API 2安装路由的方法.

有任何想法吗?

versioning api rspec rspec-api-documentation

5
推荐指数
1
解决办法
523
查看次数

rspec-api-documentation gem 显示“[二进制数据]”而不是响应正文

在降价模式 ( )下使用rspec-api-documentationconfig.format = [:markdown] gem 时,我注意到生成的文档缺少响应正文。

有永久解决这个问题的方法吗?

ruby-on-rails rspec-api-documentation

3
推荐指数
1
解决办法
691
查看次数