我是Grape
的初学者,我想使用 swagger-ui
显示我的 api 列表。我把 swagger html 放在public/swagger
,我访问 localhost:3000/swagger
但是,它一直显示404 not found
.我以为这是葡萄配置造成的。
这里是 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
您不必通过将 swagger html 放在某个地方来手动执行此操作。
您可以使用葡萄团队提供的宝石葡萄招摇,在你config.ru
中添加两行。
require 'grape-swagger'
module API
class Root < Grape::API
format :json
...
add_swagger_documentation
end
end
然后,您可以在 http://localhost:3000/swagger_doc 访问 Swagger 文档