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

Methods

Classes and Modules

Class Apipie::Application::Engine

Attributes

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)

recursively searches what versions has the controller specified in resource_description? It‘s used to derivate the default value of versions for methods.

get api for given method

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

  resource_name:
      controller class - UsersController
      string with resource name (plural) and version - "v1#users"
  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 '#' symbol.
  - "users#create" get default version
  - "v2#users#create" get specific version

get all versions of method description

options:

> "users"

> "v2#users"

> V2::UsersController

get all versions of resource description

initialize variables for gathering dsl data

the app might be nested when using contraints, namespaces etc. this method does in depth search for the route controller

[Validate]