Module: Grape::DSL::Routing::ClassMethods

Defined in:
lib/grape/dsl/routing.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#endpoints ⇒ Object (readonly)

Returns the value of attribute endpoints.



10
11
12
 
# File 'lib/grape/dsl/routing.rb', line 10

def endpoints
  @endpoints
end

Instance Method Details

#do_not_document! ⇒ Object 



80
81
82
 
# File 'lib/grape/dsl/routing.rb', line 80

def do_not_document!
  namespace_inheritable(:do_not_document, true)
end

#do_not_route_head! ⇒ Object

Do not route HEAD requests to GET requests automatically.



71
72
73
 
# File 'lib/grape/dsl/routing.rb', line 71

def do_not_route_head!
  namespace_inheritable(:do_not_route_head, true)
end

#do_not_route_options! ⇒ Object

Do not automatically route OPTIONS.



76
77
78
 
# File 'lib/grape/dsl/routing.rb', line 76

def do_not_route_options!
  namespace_inheritable(:do_not_route_options, true)
end

#mount(mounts, *opts) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/grape/dsl/routing.rb', line 84

def mount(mounts, *opts)
  mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)
  mounts.each_pair do |app, path|
    if app.respond_to?(:mount_instance)
      opts_with = opts.any? ? opts.first[:with] : {}
      mount({ app.mount_instance(configuration: opts_with) => path }, *opts)
      next
    end
    in_setting = inheritable_setting

    if app.respond_to?(:inheritable_setting, true)
      mount_path = Grape::Router.normalize_path(path)
      app.top_level_setting.namespace_stackable[:mount_path] = mount_path

      app.inherit_settings(inheritable_setting)

      in_setting = app.top_level_setting

      app.change!
      change!
    end

    # When trying to mount multiple times the same endpoint, remove the previous ones
    # from the list of endpoints if refresh_already_mounted parameter is true
    refresh_already_mounted = opts.any? ? opts.first[:refresh_already_mounted] : false
    if refresh_already_mounted && !endpoints.empty?
      endpoints.delete_if do |endpoint|
        endpoint.options[:app].to_s == app.to_s
      end
    end

    endpoints << Grape::Endpoint.new(
      in_setting,
      method: :any,
      path: path,
      app: app,
      route_options: { anchor: false },
      forward_match: !app.respond_to?(:inheritable_setting),
      for: self
    )
  end
end

#namespace(space = nil, options = {}, &block) ⇒ Object Also known as: group, resource, resources, segment

Declare a “namespace”, which prefixes all subordinate routes with its name. Any endpoints within a namespace, group, resource or segment, etc., will share their parent context as well as any configuration done in the namespace context.

Examples:


namespace :foo do
  get 'bar' do
    # defines the endpoint: GET /foo/bar
  end
end


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/grape/dsl/routing.rb', line 177

def namespace(space = nil, options = {}, &block)
  @namespace_description = nil unless instance_variable_defined?(:@namespace_description) && @namespace_description

  if space || block
    within_namespace do
      previous_namespace_description = @namespace_description
      @namespace_description = (@namespace_description || {}).deep_merge(namespace_setting(:description) || {})
      nest(block) do
        namespace_stackable(:namespace, Namespace.new(space, **options)) if space
      end
      @namespace_description = previous_namespace_description
    end
  else
    Namespace.joined_space_path(namespace_stackable(:namespace))
  end
end

#prefix(prefix = nil) ⇒ Object

Define a root URL prefix for your entire API.



56
57
58
 
# File 'lib/grape/dsl/routing.rb', line 56

def prefix(prefix = nil)
  namespace_inheritable(:root_prefix, prefix&.to_s)
end

#reset_endpoints! ⇒ Object 



210
211
212
 
# File 'lib/grape/dsl/routing.rb', line 210

def reset_endpoints!
  @endpoints = []
end

#reset_routes! ⇒ Object

Remove all defined routes.



205
206
207
208
 
# File 'lib/grape/dsl/routing.rb', line 205

def reset_routes!
  endpoints.each(&:reset_routes!)
  @routes = nil
end

#route(methods, paths = ['/'], route_options = {}, &block) ⇒ Object

Defines a route that will be recognized by the Grape API.

Examples:

Defining a basic route.

class MyAPI < Grape::API
  route(:any, '/hello') do
    {hello: 'world'}
  end
end

Parameters:

  • methods (HTTP Verb) —

    One or more HTTP verbs that are accepted by this route. Set to ‘:any` if you want any verb to be accepted.

  • paths (String) (defaults to: ['/']) —

    One or more strings representing the URL segment(s) for this route.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/grape/dsl/routing.rb', line 139

def route(methods, paths = ['/'], route_options = {}, &block)
  methods = '*' if methods == :any
  endpoint_options = {
    method: methods,
    path: paths,
    for: self,
    route_options: {
      params: namespace_stackable_with_hash(:params) || {}
    }.deep_merge(route_setting(:description) || {}).deep_merge(route_options || {})
  }

  new_endpoint = Grape::Endpoint.new(inheritable_setting, endpoint_options, &block)
  endpoints << new_endpoint unless endpoints.any? { |e| e.equals?(new_endpoint) }

  route_end
  reset_validations!
end

#route_param(param, options = {}, &block) ⇒ Object

This method allows you to quickly define a parameter route segment in your API.

Parameters:

  • param (Symbol) —

    The name of the parameter you wish to declare.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • You (Regexp) —

    may supply a regular expression that the declared parameter must meet.



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/grape/dsl/routing.rb', line 219

def route_param(param, options = {}, &block)
  options = options.dup

  options[:requirements] = {
    param.to_sym => options[:requirements]
  } if options[:requirements].is_a?(Regexp)

  Grape::Validations::ParamsScope.new(api: self) do
    requires param, type: options[:type]
  end if options.key?(:type)

  namespace(":#{param}", options, &block)
end

#routes ⇒ Object

An array of API routes.



200
201
202
 
# File 'lib/grape/dsl/routing.rb', line 200

def routes
  @routes ||= prepare_routes
end

#scope(_name = nil, &block) ⇒ Object

Create a scope without affecting the URL.

make the code more readable.

Parameters:

  • _name (Symbol) (defaults to: nil) —

    Purely placebo, just allows to name the scope to



64
65
66
67
68
 
# File 'lib/grape/dsl/routing.rb', line 64

def scope(_name = nil, &block)
  within_namespace do
    nest(block)
  end
end

#version(*args, &block) ⇒ Object

Specify an API version.

Examples:

API with legacy support.

class MyAPI < Grape::API
  version 'v2'

  get '/main' do
    {some: 'data'}
  end

  version 'v1' do
    get '/main' do
      {legacy: 'data'}
    end
  end
end


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/grape/dsl/routing.rb', line 29

def version(*args, &block)
  if args.any?
    options = args.extract_options!
    options = options.reverse_merge(using: :path)
    requested_versions = args.flatten.map(&:to_s)

    raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)

    @versions = versions | requested_versions

    if block
      within_namespace do
        namespace_inheritable(:version, requested_versions)
        namespace_inheritable(:version_options, options)

        instance_eval(&block)
      end
    else
      namespace_inheritable(:version, requested_versions)
      namespace_inheritable(:version_options, options)
    end
  end

  @versions.last if instance_variable_defined?(:@versions) && @versions
end

#versions ⇒ Object

Returns array of defined versions.

Returns:

  • array of defined versions



234
235
236
 
# File 'lib/grape/dsl/routing.rb', line 234

def versions
  @versions ||= []
end