我正在使用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方法?例如,使用knock
GEM进行身份验证:
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
,即使它删除了错误。
这真的很愚蠢,我希望将来能节省时间:
include Swagger::Docs::ImpotentMethods
只是该方法的空空间实现,就像名称所述。
包括这样的方法,它应该全部正常工作:
class Users::AuthenticationController < Knock::AuthTokenController
include Swagger::Docs::Methods
end