Class: Apipie::Configuration

External Aliases

validate	->	validate?
required_by_default	->	required_by_default?
namespaced_resources	->	namespaced_resources?
use_cache	->	use_cache?

Attributes

api_base_url	[RW]
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"
api_routes	[RW]	specify routes if used router differ from default e.g. Api::Engine.routes
app_info	[RW]
app_name	[RW]
authenticate	[RW]
authorize	[RW]
cache_dir	[W]
checksum_path	[RW]
copyright	[RW]
debug	[RW]
default_locale	[RW]
default_version	[RW]
disqus_shortname	[RW]
doc_base_url	[RW]
doc_path	[RW]
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	[W]	array of controller names (strings) (might include actions as well) to be ignored # when generationg the documentation e.g. %w[Api::CommentsController Api::PostsController#post]
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]
languages	[RW]
layout	[RW]
link_extension	[RW]
locale	[RW]
markup	[RW]
namespaced_resources	[RW]
persist_show_in_doc	[RW]
persist_show_in_doc	[W]	Persist the show_in_doc value in the examples if true. Use this if you cannot set the flag in the tests themselves (no rspec for example).
process_params	[RW]
record	[RW]
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.
required_by_default	[RW]
routes_formatter	[RW]	a object responsible for transforming the routes loaded from Rails to a form to be used in the documentation, when using the `api!` keyword. By default, it‘s Apipie::RoutesFormatter. To customize the behaviour, one can inherit from from this class and override the methods as needed.
show_all_examples	[RW]
translate	[RW]
update_checksum	[RW]
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
validate	[RW]
validate_key	[RW]
validate_presence	[RW]
validate_value	[RW]
version_in_url	[RW]