1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
# frozen_string_literal: true
require 'active_support/concern'
module Grape
module DSL
module Routing
extend ActiveSupport::Concern
include Grape::DSL::Configuration
module ClassMethods
attr_reader :endpoints
# Specify an API version.
#
# @example 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
#
def version(*args, &block)
if args.any?
options = args.extract_options!
options = options.reverse_merge(using: :path)
requested_versions = args.flatten
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
# Define a root URL prefix for your entire API.
def prefix(prefix = nil)
namespace_inheritable(:root_prefix, prefix)
end
# Create a scope without affecting the URL.
#
# @param _name [Symbol] Purely placebo, just allows to name the scope to
# make the code more readable.
def scope(_name = nil, &block)
within_namespace do
nest(block)
end
end
# Do not route HEAD requests to GET requests automatically.
def do_not_route_head!
namespace_inheritable(:do_not_route_head, true)
end
# Do not automatically route OPTIONS.
def do_not_route_options!
namespace_inheritable(:do_not_route_options, true)
end
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
# Defines a route that will be recognized
# by the Grape API.
#
# @param 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.
# @param paths [String] One or more strings representing the URL segment(s) for this route.
#
# @example Defining a basic route.
# class MyAPI < Grape::API
# route(:any, '/hello') do
# {hello: 'world'}
# end
# end
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
Grape::Http::Headers::SUPPORTED_METHODS.each do |supported_method|
define_method supported_method.downcase do |*args, &block|
options = args.extract_options!
paths = args.first || ['/']
route(supported_method, paths, options, &block)
end
end
# 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.
#
# @example
#
# namespace :foo do
# get 'bar' do
# # defines the endpoint: GET /foo/bar
# end
# end
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
alias group namespace
alias resource namespace
alias resources namespace
alias segment namespace
# An array of API routes.
def routes
@routes ||= prepare_routes
end
# Remove all defined routes.
def reset_routes!
endpoints.each(&:reset_routes!)
@routes = nil
end
def reset_endpoints!
@endpoints = []
end
# This method allows you to quickly define a parameter route segment
# in your API.
#
# @param param [Symbol] The name of the parameter you wish to declare.
# @option options [Regexp] You may supply a regular expression that the declared parameter must meet.
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
# @return array of defined versions
def versions
@versions ||= []
end
end
end
end
end
|