ruby-on-rails - 如何为 apipie-rails gem 生成 header ？

Question

我需要使用 apipie-rails 生成一个 API，但我想为标题生成文档，例如“X-User-Email”或“X-User-Token”。

我有这个资源描述:

resource_description do
   short 'Cars'
   formats ['json']
   param 'X-User-Email <X-User-Email>', String, :desc => "HEADER param: Email must correspond to TOKEN owner", :required => false
   param 'X-User-Token <X-User-Token>', String, :desc => "HEADER param: Token must correspond to EMAIL owner", :required => false
   error :code => 401, :desc => "Unauthorized - Returned when authentication can't be achieved via login or missing/expired api token"
end

但是，参数 param 在这种情况下对我没有帮助。

这可能吗？

Answer 1

你可以这样做:

header 'X-User-Email', '...expected value...'