Grape-Swagger 未列出基于葡萄的方法 API

Question

我正在使用 grape-swagger gem，但我无法获得 Swagger 中正确描述的基于葡萄的 API。使用：grape (0.11.0) 和 grape-swagger (0.10.1)

当我启用 Swagger json 列表时，我得到的输出列出了所有端点，但没有列出每个端点中包含的方法。

我的输出：

{
  "apiVersion": "v0",
  "swaggerVersion": "1.2",
  "produces": [
    "application/json"
  ],
  "apis": [
    {
    "path": "/version.{format}",
    "description": "Operations about versions"
    },
    {
    "path": "/ping.{format}",
    "description": "Operations about pings"
    },
    {
    "path": "/users.{format}",
    "description": "Operations about users"
    },
    {
    "path": "/company.{format}",
    "description": "Operations about companies"
    },
    {
    "path": "/merchants.{format}",
    "description": "Operations about merchants"
    }
  ],
  "info": {}
}

我还在 config.ru 中添加了 CORS 津贴，如下所示：

require 'rack/cors'
use Rack::Cors do
  allow do
    origins '*'
    resource '*',
      headers: :any,
      methods: [:get, :post, :put, :delete, :options]
  end
end

关于如何获取其中列出的每个端点的方法的任何线索？

Answer 1

这不是 Swagger 1.2 的工作方式。

假设您在 /api-docs 处得到上述 JSON，请尝试打开 /api-docs/version.json 以查看 version 的操作。当然，如果它不在 /api-docs 下托管，只需将那部分替换为实际使用的路径段即可。

Grape-Swagger 未列出基于葡萄的方法 API

Grape-Swagger not listing methods contained in a grape-based API

ruby

swagger

ruby-grape

api-doc