Class Apipie::Application
In: lib/apipie/application.rb
Parent: Object

Methods

Classes and Modules

Class Apipie::Application::Engine

Attributes

last_api_args  [RW] 
last_description  [RW] 
last_errors  [RW] 
last_examples  [RW] 
last_formats  [RW] 
last_params  [RW] 
last_see  [RW] 
method_descriptions  [R] 
resource_descriptions  [R] 

Public Class methods

Public Instance methods

[](resource_name, method_name = nil)

Is there a reason to interpret the DSL for this run? with specific setting for some environment there is no reason the dsl should be interpreted (e.g. no validations and doc from cache)

check if there is some saved description

Clear all apis in this application.

clear all saved data

Return the current description, clearing it in the process.

get api for given method

There are two ways how this method can be used: 1) Specify both parameters

  resource_name: controller class or string with resource name (plural)
  method_name: name of the method (string or symbol)

2) Specify only first parameter:

  resource_name: string containing both resource and method name joined
  with # (eg. "users#create")

[Validate]