Grape Swagger UI - Uncaught TypeError: Cannot read property 'definitions' of null

Question

所以我在使用 Swagger UI 并尝试点击 API 时遇到了这个错误。

Uncaught TypeError: Cannot read property 'definitions' of null

我正在使用 gem grape-swagger 并且 UI 表示正在尝试检索记录。

Answer 1

问题是，团队的另一位成员评论了该行

add_swagger_documentation api_version: 'v1', mount_path: '/docs'

必须放在 class AFTER 所有挂载的 API

class Root < Grape::API
  blah blah blah...
  mount BLAH::BLAH
  mount FOO::BAR
  add_swagger_documentation api_version: 'v1', mount_path: '/docs'
end

再次放置后，它成功了！

Answer 2

未捕获类型错误：无法读取属性 'definitions' of null

swagger 集成已完成，我收到上述错误。因为我在 rest 服务上缺少 @Api 注释，所以我试图运行。希望这可能是您收到此错误的原因之一

Answer 3

希望这对在这里发现这个问题的人有所帮助。我也遇到了同样的错误。但原因不同。这里的原因是我在所有api的挂载上面添加了'add_swagger_documentation'方法

这里我在 Rails 4.2

中使用 grape-swagger-rails gem 和 Grape

我们必须在挂载所有葡萄api后添加方法'add_swagger_documentation'。

查看以下github对话

https://github.com/ruby-grape/grape-swagger-rails/issues/58

Grape Swagger UI - Uncaught TypeError: Cannot read property 'definitions' of null

Grape Swagger UI - Uncaught TypeError: Cannot read property 'definitions' of null

ruby-grape

swagger

ruby-on-rails-4

grape-api

swagger-ui