Rails葡萄秀404页面

Question

我是 Grape 的初学者，我想使用 swagger-ui 显示我的 api 列表。 我把 swagger html 放在 public/swagger 中，然后访问 localhost:3000/swagger

但是，它一直显示 404 not found。我以为是 Grape 配置引起的。

这里是api.rb

#app/api/twitter/api/api.rb

require 'grape'
module Twitter
  class API < Grape::API
    version 'v1', using: :header, vendor: 'twitter'
    format :json
    prefix :api
    add_swagger_documentation

    resource :statuses do
      desc 'Return a public timeline.'
      get :public_timeline do
        Status.limit(20)
      end
    end
  end
end

Answer 1

您不必通过在某处放置 swagger html 来手动完成。

可以使用Grape团队提供的gem grape-swagger，在config.ru.

中添加两行

require 'grape-swagger'

module API
  class Root < Grape::API
    format :json
    ...
    add_swagger_documentation
  end
end

然后您可以在 http://localhost:3000/swagger_doc

访问 swagger 文档