Classes and Modules

Attributes

last_dsl_data	[RW]
resource_descriptions	[R]

Public Class methods

new()

Public Instance methods

[](resource_name, method_name = nil)

Alias for get_method_description

active_dsl?()

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)

add_example(example)

add_method_description_args(method, path, desc)

api_controllers_paths()

apipie_provided?()

check if there is some saved description

available_versions()

clear_last()

clear all saved data

controller_versions(controller)

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

define_method_description(controller, method_name, versions = [])

create new method api description

define_resource_description(controller, version, dsl_data = nil)

create new resource api description

get_method_description(resource_name, method_name = nil)

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_method_descriptions(resource, method)

get all versions of method description

get_resource_description(resource, version = nil)

options: