Module: Grape::DSL::Routing::ClassMethods
- Defined in:
- lib/grape/dsl/routing.rb
Instance Attribute Summary collapse
-
#endpoints ⇒ Object
readonly
Returns the value of attribute endpoints.
Instance Method Summary collapse
- #do_not_document! ⇒ Object
-
#do_not_route_head! ⇒ Object
Do not route HEAD requests to GET requests automatically.
-
#do_not_route_options! ⇒ Object
Do not automatically route OPTIONS.
- #mount(mounts, *opts) ⇒ Object
-
#namespace(space = nil, options = {}, &block) ⇒ Object
(also: #group, #resource, #resources, #segment)
Declare a “namespace”, which prefixes all subordinate routes with its name.
-
#prefix(prefix = nil) ⇒ Object
Define a root URL prefix for your entire API.
- #reset_endpoints! ⇒ Object
-
#reset_routes! ⇒ Object
Remove all defined routes.
-
#route(methods, paths = ['/'], route_options = {}, &block) ⇒ Object
Defines a route that will be recognized by the Grape API.
-
#route_param(param, options = {}, &block) ⇒ Object
This method allows you to quickly define a parameter route segment in your API.
-
#routes ⇒ Object
An array of API routes.
-
#scope(_name = nil, &block) ⇒ Object
Create a scope without affecting the URL.
-
#version(*args, &block) ⇒ Object
Specify an API version.
-
#versions ⇒ Object
Array of defined versions.
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 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 |
# 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.shift[:with] : {} mount({ app.mount_instance(configuration: opts_with) => path }) 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 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.
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/grape/dsl/routing.rb', line 168 def namespace(space = nil, = {}, &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, **)) 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) end |
#reset_endpoints! ⇒ Object
201 202 203 |
# File 'lib/grape/dsl/routing.rb', line 201 def reset_endpoints! @endpoints = [] end |
#reset_routes! ⇒ Object
Remove all defined routes.
196 197 198 199 |
# File 'lib/grape/dsl/routing.rb', line 196 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.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/grape/dsl/routing.rb', line 130 def route(methods, paths = ['/'], = {}, &block) methods = '*' if methods == :any = { method: methods, path: paths, for: self, route_options: { params: namespace_stackable_with_hash(:params) || {} }.deep_merge(route_setting(:description) || {}).deep_merge( || {}) } new_endpoint = Grape::Endpoint.new(inheritable_setting, , &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.
210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/grape/dsl/routing.rb', line 210 def route_param(param, = {}, &block) = .dup [:requirements] = { param.to_sym => [:requirements] } if [:requirements].is_a?(Regexp) Grape::Validations::ParamsScope.new(api: self) do requires param, type: [:type] end if .key?(:type) namespace(":#{param}", , &block) end |
#routes ⇒ Object
An array of API routes.
191 192 193 |
# File 'lib/grape/dsl/routing.rb', line 191 def routes @routes ||= prepare_routes end |
#scope(_name = nil, &block) ⇒ Object
Create a scope without affecting the URL.
make the code more readable.
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.
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? = args. = .reverse_merge(using: :path) requested_versions = args.flatten raise Grape::Exceptions::MissingVendorOption.new if [:using] == :header && !.key?(:vendor) @versions = versions | requested_versions if block within_namespace do namespace_inheritable(:version, requested_versions) namespace_inheritable(:version_options, ) instance_eval(&block) end else namespace_inheritable(:version, requested_versions) namespace_inheritable(:version_options, ) end end @versions.last if instance_variable_defined?(:@versions) && @versions end |
#versions ⇒ Object
Returns array of defined versions.
225 226 227 |
# File 'lib/grape/dsl/routing.rb', line 225 def versions @versions ||= [] end |