Class Grape::Namespace
In: lib/grape/namespace.rb
Parent: Object

A container for endpoints or other namespaces, which allows for both logical grouping of endpoints as well as sharing common configuration. May also be referred to as group, segment, or resource.

Methods

joined_space   joined_space_path   new   requirements  

Attributes

options  [R] 
space  [R] 

Public Class methods

joined_space_path(settings)

Join the namespaces from a list of settings to create a path prefix. @param settings [Array] list of Grape::Util::InheritableSettings.

new(space, **options)

@param space [String] the name of this namespace @param options [Hash] options hash @option options :requirements [Hash] param-regex pairs, all of which must 

  be met by a request's params for all endpoints in this namespace, or
  validation will fail and return a 422.

Public Instance methods

requirements()

Retrieves the requirements from the options hash, if given. @return [Hash]

[Validate]