如何在继承自不同基本控制器的控制器中包含 swagger-docs？

Question

我正在使用swagger-docs向 API 添加文档，我的配置如下所示：

Swagger::Docs::Config.register_apis({
  "1.0" => {
    :api_file_path => "public/",
    :base_path => "http://localhost:3000",
    :clean_directory => true,
    :base_api_controller => ActionController::API,
    :attributes => {
      :info => {
        "title" => "Test",
        "description" => "Test",
        "contact" => "contact@example.com",
        "license" => "MIT",
        "licenseUrl" => "https://opensource.org/licenses/MIT"
      }
    }
  }
})

这适用于继承自 的控制器ActionController::API，但是当控制器从不同的基本控制器继承时，我如何包含 DSL 方法？例如，当使用knockgem 进行身份验证时：

class Users::AuthenticationController < Knock::AuthTokenController
  swagger_controller :login, "Request a new JWT to issue authenticated requests"

  swagger_api :create do
    summary "Generates a JWT to be used for authenticated requests"
    param :email, "auth[email]", :string, :required, "Email for authentication"
    param :password, "auth[password]", :string, :required, "Password for authentication"
    response :created
    response :not_found, "Credentials specified were wrong"
  end

  def entity_class
    User
  end
end

此代码返回以下错误：

undefined method `swagger_controller' for Users::AuthenticationController:Class

我尝试包括使用的方法：

include Swagger::Docs::ImpotentMethods

但这不起作用，即使它消除了错误。

Answer 1

这真的很愚蠢，我希望它可以为将来的某人节省时间：

include Swagger::Docs::ImpotentMethods 正如名字所说，只是方法的一个空实现。

包括这样的方法，它应该都能正常工作：

class Users::AuthenticationController < Knock::AuthTokenController
  include Swagger::Docs::Methods
end