api_controllers_matcher |
[RW] |
matcher to be used in Dir.glob to find controllers to be reloaded e.g.
"#{Rails.root}/app/controllers/api/*.rb"
|
force_dsl |
[W] |
if there is not obvious reason why the DSL should be
turned on (no validations, cache turned on etc.), it‘s disabled to
avoid unneeded allocation. It you need the DSL for
other reasons, you can force the activation.
|
generated_doc_disclaimer |
[W] |
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.
|
ignored_by_recorder |
[W] |
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]
|
reload_controllers |
[W] |
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.
|
use_cache |
[RW] |
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
|