matcher to be used in Dir.glob to find controllers to be reloaded e.g.
"#{Rails.root}/app/controllers/api/*.rb"
comment to put before docs that was generated automatically. It's used to determine if the description should be overwritten next recording. If you want to keep the documentation (prevent from overriding), remove the line above the docs.
array of controller names (strings) (might include actions as well) to be ignored # when extracting description form calls. e.g. %w[Api::CommentsController Api::PostsController#post]
set to true if you want to reload the controllers at each refresh of the
documentation. It requires :api_controllers_matcher
to be set
to work properly.
set to true if you want to use pregenerated documentation cache and avoid generating the documentation on runtime (usefull for production environment). You can generate the cache by running
rake apipie:cache
set to true if you want to use pregenerated documentation cache and avoid generating the documentation on runtime (usefull for production environment). You can generate the cache by running
rake apipie:cache
# File lib/apipie/apipie_module.rb, line 94 def initialize @markup = Apipie::Markup::RDoc.new @app_name = "Another API" @app_info = "Another API description" @copyright = nil @validate = true @api_base_url = "" @doc_base_url = "/apipie" end
# File lib/apipie/apipie_module.rb, line 59 def cache_dir @cache_dir ||= File.join(Rails.root, "public", "apipie-cache") end
# File lib/apipie/apipie_module.rb, line 68 def force_dsl? @force_dsl end
# File lib/apipie/apipie_module.rb, line 86 def generated_doc_disclaimer @generated_doc_disclaimer ||= "# DOC GENERATED AUTOMATICALLY: REMOVE THIS LINE TO PREVENT REGENARATING NEXT TIME" end
# File lib/apipie/apipie_module.rb, line 76 def ignored_by_recorder @ignored_by_recorder ||= [] @ignored_by_recorder.map(&:to_s) end
# File lib/apipie/apipie_module.rb, line 44 def reload_controllers? @reload_controllers = Rails.env.development? unless defined? @reload_controllers return @reload_controllers && @api_controllers_matcher end