Table of Contents - apipie-rails-0.5.1 Documentation
Pages
Classes and Modules
- ActionDispatch
- ActionDispatch::Routing
- Apipie
- Apipie::Application
- Apipie::Application::Engine
- Apipie::Client
- Apipie::Client::Generator
- Apipie::Configuration
- Apipie::DSL
- Apipie::DSL::Action
- Apipie::DSL::Base
- Apipie::DSL::Common
- Apipie::DSL::Concern
- Apipie::DSL::Controller
- Apipie::DSL::Param
- Apipie::DSL::Resource
- Apipie::DSL::ResourceDescriptionDsl
- Apipie::DefinedParamError
- Apipie::Error
- Apipie::ErrorDescription
- Apipie::Extractor
- Apipie::Extractor::ActionDescriptionUpdater
- Apipie::Extractor::ActionDescriptionUpdater::ActionNotFound
- Apipie::Extractor::ActionDescriptionUpdater::ControllerNotFound
- Apipie::Extractor::Collector
- Apipie::Extractor::OrderedHash
- Apipie::Extractor::Recorder
- Apipie::Extractor::Recorder::FunctionalTestRecording
- Apipie::Extractor::Recorder::Middleware
- Apipie::Extractor::Writer
- Apipie::FileHandler
- Apipie::Helpers
- Apipie::InstallGenerator
- Apipie::Markup
- Apipie::Markup::Markdown
- Apipie::Markup::RDoc
- Apipie::Markup::Textile
- Apipie::MethodDescription
- Apipie::MethodDescription::Api
- Apipie::Middleware
- Apipie::Middleware::ChecksumInHeaders
- Apipie::ParamDescription
- Apipie::ParamError
- Apipie::ParamInvalid
- Apipie::ParamMissing
- Apipie::Railtie
- Apipie::Railtie::ActionController
- Apipie::Railtie::ActionController::TestCase
- Apipie::ResourceDescription
- Apipie::RoutesFormatter
- Apipie::Routing
- Apipie::Routing::MapperExtensions
- Apipie::SeeDescription
- Apipie::StaticDispatcher
- Apipie::UnknownCode
- Apipie::UnknownParam
- Apipie::Validator
- Apipie::Validator::ArrayClassValidator
- Apipie::Validator::ArrayValidator
- Apipie::Validator::BaseValidator
- Apipie::Validator::BooleanValidator
- Apipie::Validator::EnumValidator
- Apipie::Validator::HashValidator
- Apipie::Validator::NestedValidator
- Apipie::Validator::NumberValidator
- Apipie::Validator::ProcValidator
- Apipie::Validator::RegexpValidator
- Apipie::Validator::TypeValidator
- Apipie::Validator::UndefValidator
- Apipie::ViewsGenerator
Methods
- ::all_api_routes — Apipie::Extractor
- ::all_apis_from_docs — Apipie::Extractor
- ::api_base_url — Apipie
- ::api_base_url_version_valid? — Apipie
- ::apis_from_routes — Apipie::Extractor
- ::app — Apipie
- ::app_info — Apipie
- ::app_info_version_valid? — Apipie
- ::build — Apipie::Validator::TypeValidator
- ::build — Apipie::Validator::RegexpValidator
- ::build — Apipie::Validator::EnumValidator
- ::build — Apipie::Validator::ArrayValidator
- ::build — Apipie::Validator::ArrayClassValidator
- ::build — Apipie::Validator::ProcValidator
- ::build — Apipie::Validator::HashValidator
- ::build — Apipie::Validator::UndefValidator
- ::build — Apipie::Validator::NumberValidator
- ::build — Apipie::Validator::BooleanValidator
- ::build — Apipie::Validator::NestedValidator
- ::call_finished — Apipie::Extractor
- ::call_recorder — Apipie::Extractor
- ::clean_call_recorder — Apipie::Extractor
- ::configuration — Apipie
- ::configure — Apipie
- ::controller_path — Apipie::Extractor
- ::debug — Apipie
- ::destination_root — Apipie::Client::Generator
- ::eval_dsl — Apipie::DSL::ResourceDescriptionDsl
- ::examples_file — Apipie::Extractor::Writer
- ::find — Apipie::Validator::BaseValidator
- ::finish — Apipie::Extractor
- ::from_dsl_data — Apipie::ErrorDescription
- ::from_dsl_data — Apipie::ParamDescription
- ::inherited — Apipie::Validator::BaseValidator
- ::load_json_examples — Apipie::Extractor::Writer
- ::load_recorded_examples — Apipie::Extractor::Writer
- ::logger — Apipie::Extractor::Writer
- ::logger — Apipie::Extractor
- ::method_missing — Apipie
- ::new — Apipie::Application
- ::new — Apipie::Client::Generator
- ::new — Apipie::Configuration
- ::new — Apipie::DSL::ResourceDescriptionDsl
- ::new — Apipie::ErrorDescription
- ::new — Apipie::DefinedParamError
- ::new — Apipie::ParamInvalid
- ::new — Apipie::Extractor::Collector
- ::new — Apipie::Extractor::Recorder
- ::new — Apipie::Extractor::Recorder::Middleware
- ::new — Apipie::Extractor::Writer
- ::new — Apipie::Extractor::ActionDescriptionUpdater
- ::new — Apipie::Markup::RDoc
- ::new — Apipie::Markup::Markdown
- ::new — Apipie::Markup::Textile
- ::new — Apipie::MethodDescription
- ::new — Apipie::MethodDescription::Api
- ::new — Apipie::Middleware::ChecksumInHeaders
- ::new — Apipie::ParamDescription
- ::new — Apipie::ResourceDescription
- ::new — Apipie::SeeDescription
- ::new — Apipie::FileHandler
- ::new — Apipie::StaticDispatcher
- ::new — Apipie::Validator::BaseValidator
- ::new — Apipie::Validator::TypeValidator
- ::new — Apipie::Validator::RegexpValidator
- ::new — Apipie::Validator::EnumValidator
- ::new — Apipie::Validator::ArrayValidator
- ::new — Apipie::Validator::ArrayClassValidator
- ::new — Apipie::Validator::ProcValidator
- ::new — Apipie::Validator::HashValidator
- ::new — Apipie::Validator::NestedValidator
- ::populate_api_routes — Apipie::Extractor
- ::record — Apipie
- ::source_root — Apipie::Client::Generator
- ::start — Apipie::Client::Generator
- ::start — Apipie::Extractor
- ::to_json — Apipie
- ::unify — Apipie::ParamDescription
- ::update_action_description — Apipie::Extractor::Writer
- ::update_api_descriptions — Apipie::Extractor
- ::validate — Apipie::Validator::NumberValidator
- ::write_docs — Apipie::Extractor
- ::write_examples — Apipie::Extractor
- ::write_recorded_examples — Apipie::Extractor::Writer
- #[] — Apipie::Application
- #_api_base_url — Apipie::ResourceDescription
- #_apipie_concern_data — Apipie::DSL::Concern
- #_apipie_concern_subst — Apipie::DSL::Controller
- #_apipie_define_validators — Apipie::DSL::Common
- #_apipie_dsl_data — Apipie::DSL::Base
- #_apipie_dsl_data_clear — Apipie::DSL::Base
- #_apipie_dsl_data_init — Apipie::DSL::Base
- #_apipie_get_method_params — Apipie::DSL::Common
- #_apipie_perform_concern_subst — Apipie::DSL::Controller
- #_apipie_save_method_params — Apipie::DSL::Common
- #_default_param_group_scope — Apipie::Validator::HashValidator
- #_default_param_group_scope — Apipie::DSL::Param
- #_eval_dsl — Apipie::DSL::ResourceDescriptionDsl
- #_version — Apipie::ResourceDescription
- #action_aware? — Apipie::ParamDescription
- #action_awareness — Apipie::ParamDescription
- #action_line — Apipie::Extractor::ActionDescriptionUpdater
- #active_dsl? — Apipie::Application
- #add_method_description — Apipie::ResourceDescription
- #add_param_group — Apipie::Application
- #add_route — Apipie::InstallGenerator
- #add_routes_info — Apipie::Extractor::Collector
- #add_to_records — Apipie::Extractor::Collector
- #align_indented — Apipie::Extractor::ActionDescriptionUpdater
- #all? — Apipie::Client::Generator
- #analyse_controller — Apipie::Extractor::Recorder
- #analyse_env — Apipie::Extractor::Recorder
- #analyse_response — Apipie::Extractor::Recorder
- #analyze — Apipie::Extractor::Recorder::Middleware
- #analyze_functional_test — Apipie::Extractor::Recorder
- #api — Apipie::Client::Generator
- #api — Apipie::DSL::Action
- #api! — Apipie::DSL::Action
- #api_base_url — Apipie::DSL::Resource
- #api_base_url= — Apipie::Configuration
- #api_controllers_paths — Apipie::Application
- #api_data — Apipie::MethodDescription
- #api_description — Apipie::Extractor::Recorder
- #api_url — Apipie::ResourceDescription
- #api_version — Apipie::DSL::Common
- #api_versions — Apipie::DSL::Common
- #apipie — Apipie::Routing::MapperExtensions
- #apipie_concern? — Apipie::DSL::Controller
- #apipie_concern? — Apipie::DSL::Concern
- #apipie_concern_subst — Apipie::DSL::Controller
- #app_info — Apipie::DSL::Resource
- #app_info= — Apipie::Configuration
- #as_action — Apipie::ParamDescription
- #available_versions — Apipie::Application
- #cache_dir — Apipie::Configuration
- #cache_extension — Apipie::FileHandler
- #call — Apipie::Extractor::Recorder::Middleware
- #call — Apipie::Middleware::ChecksumInHeaders
- #call — Apipie::FileHandler
- #call — Apipie::StaticDispatcher
- #camelizer — Apipie::Client::Generator
- #checksum — Apipie::Application
- #class_base — Apipie::Client::Generator
- #class_suffix — Apipie::Client::Generator
- #client_args — Apipie::Client::Generator
- #compute_checksum — Apipie::Application
- #concern_subst — Apipie::MethodDescription
- #concern_subst — Apipie::ParamDescription
- #content_disposition — Apipie::Extractor::Recorder
- #controller_content — Apipie::Extractor::ActionDescriptionUpdater
- #controller_content= — Apipie::Extractor::ActionDescriptionUpdater
- #controller_full_path — Apipie::Extractor::Collector
- #controller_path — Apipie::Extractor::ActionDescriptionUpdater
- #controller_versions — Apipie::Application
- #convert_file_value — Apipie::Extractor::Writer
- #copy_views — Apipie::ViewsGenerator
- #create_api_url — Apipie::MethodDescription
- #create_initializer — Apipie::InstallGenerator
- #deep_merge_examples — Apipie::Extractor::Writer
- #def_param_group — Apipie::DSL::Action
- #define_method_description — Apipie::Application
- #define_resource_description — Apipie::Application
- #desc — Apipie::DSL::Common
- #desc_to_s — Apipie::Extractor::Writer
- #description — Apipie::Validator::BaseValidator
- #description — Apipie::Validator::TypeValidator
- #description — Apipie::Validator::RegexpValidator
- #description — Apipie::Validator::EnumValidator
- #description — Apipie::Validator::ArrayValidator
- #description — Apipie::Validator::ArrayClassValidator
- #description — Apipie::Validator::ProcValidator
- #description — Apipie::Validator::HashValidator
- #description — Apipie::Validator::UndefValidator
- #description — Apipie::Validator::NumberValidator
- #description — Apipie::Validator::BooleanValidator
- #description — Apipie::Validator::NestedValidator
- #description — Apipie::DSL::Common
- #doc_url — Apipie::MethodDescription
- #doc_url — Apipie::ResourceDescription
- #document — Apipie::DSL::Common
- #ensure_line_breaks — Apipie::Extractor::ActionDescriptionUpdater
- #enum — Apipie::Validator::ArrayValidator
- #error — Apipie::Validator::BaseValidator
- #error — Apipie::Validator::ProcValidator
- #error — Apipie::DSL::Common
- #errors — Apipie::MethodDescription
- #example — Apipie::DSL::Action
- #expected_type — Apipie::Validator::BaseValidator
- #expected_type — Apipie::Validator::TypeValidator
- #expected_type — Apipie::Validator::ArrayValidator
- #expected_type — Apipie::Validator::HashValidator
- #expected_type — Apipie::Validator::BooleanValidator
- #expected_type — Apipie::Validator::NestedValidator
- #ext — Apipie::FileHandler
- #finalize_descriptions — Apipie::Extractor::Collector
- #force_dsl? — Apipie::Configuration
- #format_example — Apipie::MethodDescription
- #format_example_data — Apipie::MethodDescription
- #format_path — Apipie::RoutesFormatter
- #format_route — Apipie::RoutesFormatter
- #format_routes — Apipie::RoutesFormatter
- #format_verb — Apipie::RoutesFormatter
- #formats — Apipie::DSL::Common
- #from_concern? — Apipie::MethodDescription
- #from_concern? — Apipie::ParamDescription
- #full_description — Apipie::DSL::Common
- #full_name — Apipie::ParamDescription
- #full_url — Apipie::Helpers
- #generate_apis_code — Apipie::Extractor::ActionDescriptionUpdater
- #generate_cli — Apipie::Client::Generator
- #generate_code — Apipie::Extractor::ActionDescriptionUpdater
- #generate_errors_code — Apipie::Extractor::ActionDescriptionUpdater
- #generate_params_code — Apipie::Extractor::ActionDescriptionUpdater
- #generated? — Apipie::Extractor::ActionDescriptionUpdater
- #generated_doc_disclaimer — Apipie::Configuration
- #get_base_url — Apipie::Application
- #get_method_description — Apipie::Application
- #get_method_descriptions — Apipie::Application
- #get_param_group — Apipie::Application
- #get_resource_description — Apipie::Application
- #get_resource_descriptions — Apipie::Application
- #get_resource_name — Apipie::Application
- #get_resource_version — Apipie::Application
- #handle_record — Apipie::Extractor::Collector
- #has_valid_type? — Apipie::Validator::ArrayValidator
- #hash_nodes_count — Apipie::Extractor::Writer
- #header — Apipie::DSL::Common
- #id — Apipie::MethodDescription
- #ignore_call? — Apipie::Extractor::Collector
- #ignored — Apipie::Configuration
- #ignored? — Apipie::Application
- #ignored_by_recorder — Apipie::Configuration
- #include_javascripts — Apipie::Helpers
- #include_stylesheets — Apipie::Helpers
- #included — Apipie::DSL::Concern
- #init_env — Apipie::Application
- #is_required? — Apipie::ParamDescription
- #is_valid_value? — Apipie::Validator::ArrayValidator
- #items — Apipie::Validator::ArrayValidator
- #label_class_for_error — Apipie::Helpers
- #lines_above_method — Apipie::Extractor::ActionDescriptionUpdater
- #load_controller_from_file — Apipie::Application
- #load_documentation — Apipie::Application
- #load_new_examples — Apipie::Extractor::Writer
- #load_old_examples — Apipie::Extractor::Writer
- #load_recorded_examples — Apipie::Extractor::Writer
- #load_recorded_examples — Apipie::MethodDescription
- #locale — Apipie::Application
- #locale= — Apipie::Application
- #logger — Apipie::Extractor::Writer
- #logger — Apipie::Extractor::ActionDescriptionUpdater
- #markup_to_html — Apipie::Helpers
- #match? — Apipie::FileHandler
- #merge_old_new_examples — Apipie::Extractor::Writer
- #merge_params — Apipie::MethodDescription
- #merge_with — Apipie::ParamDescription
- #merge_with — Apipie::Validator::BaseValidator
- #merge_with — Apipie::Validator::HashValidator
- #meta — Apipie::DSL::Common
- #method_added — Apipie::DSL::Controller
- #method_added — Apipie::DSL::Concern
- #method_apis_to_json — Apipie::MethodDescription
- #method_description — Apipie::ResourceDescription
- #method_descriptions — Apipie::ResourceDescription
- #name — Apipie::DSL::Resource
- #normalized_value — Apipie::ParamDescription
- #old_header — Apipie::Extractor::ActionDescriptionUpdater
- #ordered_call — Apipie::Extractor::Writer
- #overwrite_header — Apipie::Extractor::ActionDescriptionUpdater
- #param — Apipie::DSL::Param
- #param_group — Apipie::DSL::Param
- #param_name — Apipie::Validator::BaseValidator
- #params — Apipie::MethodDescription
- #params_in_path — Apipie::Client::Generator
- #params_ordered — Apipie::MethodDescription
- #params_ordered — Apipie::Validator::BaseValidator
- #params_ordered — Apipie::Validator::HashValidator
- #params_ordered — Apipie::Validator::NestedValidator
- #parents_and_self — Apipie::ParamDescription
- #parse_data — Apipie::Extractor::Recorder
- #path — Apipie::DSL::Resource
- #plaintext — Apipie::Client::Generator
- #preformat_text — Apipie::ParamDescription
- #prepare_hash_params — Apipie::Validator::HashValidator
- #process — Apipie::Extractor::Recorder::FunctionalTestRecording
- #process_value — Apipie::ParamDescription
- #process_value — Apipie::Validator::ArrayValidator
- #process_value — Apipie::Validator::HashValidator
- #process_value — Apipie::Validator::NestedValidator
- #process_value? — Apipie::Configuration
- #rails_mark_classes_for_reload — Apipie::Application
- #rails_routes — Apipie::Application
- #record — Apipie::Extractor::Recorder
- #record_to_s — Apipie::Extractor::Collector
- #recorded_examples — Apipie::Application
- #refine_description — Apipie::Extractor::Collector
- #refine_errors_description — Apipie::Extractor::Collector
- #refine_params_description — Apipie::Extractor::Collector
- #reformat_data — Apipie::Extractor::Recorder
- #reformat_hash — Apipie::Extractor::Recorder
- #reformat_multipart_data — Apipie::Extractor::Recorder
- #reload_controllers? — Apipie::Configuration
- #reload_documentation — Apipie::Application
- #reload_examples — Apipie::Application
- #remove_method_description — Apipie::Application
- #remove_method_description — Apipie::ResourceDescription
- #request_script_name — Apipie::Helpers
- #request_script_name= — Apipie::Helpers
- #resource_description — Apipie::DSL::Action
- #resource_id — Apipie::DSL::Resource
- #resource_name — Apipie::Client::Generator
- #route_app_controller — Apipie::Application
- #routes_for_action — Apipie::Application
- #see — Apipie::DSL::Action
- #see_url — Apipie::SeeDescription
- #set_controller_versions — Apipie::Application
- #set_resource_id — Apipie::Application
- #short — Apipie::DSL::Resource
- #short_description — Apipie::DSL::Resource
- #show — Apipie::DSL::Action
- #showable_in_doc? — Apipie::Extractor::Writer
- #substituted_url — Apipie::Client::Generator
- #to_html — Apipie::Markup::RDoc
- #to_html — Apipie::Markup::Markdown
- #to_html — Apipie::Markup::Textile
- #to_json — Apipie::Application
- #to_json — Apipie::ErrorDescription
- #to_json — Apipie::MethodDescription
- #to_json — Apipie::ParamDescription
- #to_json — Apipie::ResourceDescription
- #to_json — Apipie::SeeDescription
- #to_json — Apipie::Validator::BaseValidator
- #to_s — Apipie::ParamMissing
- #to_s — Apipie::UnknownParam
- #to_s — Apipie::ParamInvalid
- #to_s — Apipie::Validator::BaseValidator
- #to_yaml — Apipie::Extractor::OrderedHash
- #to_yaml_type — Apipie::Extractor::OrderedHash
- #transformation_hash — Apipie::Client::Generator
- #translate — Apipie::Application
- #update — Apipie::Extractor::ActionDescriptionUpdater
- #update_apis — Apipie::Extractor::ActionDescriptionUpdater
- #update_from_dsl_data — Apipie::ResourceDescription
- #update_generated_description — Apipie::Extractor::ActionDescriptionUpdater
- #use_disqus? — Apipie::Configuration
- #valid? — Apipie::Validator::BaseValidator
- #valid_method_name? — Apipie::ResourceDescription
- #valid_search_args? — Apipie::Application
- #validate — Apipie::ParamDescription
- #validate — Apipie::Validator::TypeValidator
- #validate — Apipie::Validator::RegexpValidator
- #validate — Apipie::Validator::EnumValidator
- #validate — Apipie::Validator::ArrayValidator
- #validate — Apipie::Validator::ArrayClassValidator
- #validate — Apipie::Validator::ProcValidator
- #validate — Apipie::Validator::HashValidator
- #validate — Apipie::Validator::UndefValidator
- #validate — Apipie::Validator::NumberValidator
- #validate — Apipie::Validator::BooleanValidator
- #validate — Apipie::Validator::NestedValidator
- #validate_item — Apipie::Validator::ArrayValidator
- #validation — Apipie::Client::Generator
- #version — Apipie::MethodDescription
- #version_prefix — Apipie::Application
- #write! — Apipie::Extractor::ActionDescriptionUpdater
- #write_docs — Apipie::Extractor::Writer
- #write_examples — Apipie::Extractor::Writer