модуль ActionDispatch::Routing::Mapper::Base

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 636
def has_named_route?(name)
  @set.named_routes.key? name
end

Проверяет, определён ли указанный именованный маршрут.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 572
def match(path, options=nil)
end

Сопоставляет шаблон URL с одним или несколькими маршрутами.

Не следует использовать метод match в маршрутизаторе без указания HTTP-метода.

Если необходимо предоставить доступ к действию и для GET, и для POST, используйте:

# sets :controller, :action and :id in params
match ':controller/:action/:id', via: [:get, :post]

Обратите внимание, что :controller, :action и :id интерпретируются как параметры запроса URL и, следовательно, доступны в действии через params.

Если необходимо предоставить доступ к действию только для GET, используйте get в маршрутизаторе:

Вместо:

match ":controller/:action/:id"

Используйте:

get ":controller/:action/:id"

Два из этих символов являются специальными, :controller сопоставляется с контроллером, а :action — с методом контроллера. Шаблон также может сопоставлять символы подстановки (глобы) с параметрами:

get 'songs/*category/:title', to: 'songs#show'

# 'songs/rock/classic/stairway-to-heaven' sets
#  params[:category] = 'rock/classic'
#  params[:title] = 'stairway-to-heaven'

Для сопоставления параметра с символом подстановки ему необходимо присвоить имя. Без имени переменной для привязки параметра с символом подстановки маршрут невозможно проанализировать.

Если шаблон указывает на внутренний маршрут, :action и :controller маршрута следует задать в параметрах или в сокращенном виде в виде хеша. Примеры:

match 'photos/:id' => 'photos#show', via: :get
match 'photos/:id', to: 'photos#show', via: :get
match 'photos/:id', controller: 'photos', action: 'show', via: :get

Шаблон также может указывать на конечную точку Rack , т. е. на любой объект, который отвечает на call:

match 'photos/:id', to: -> (hash) { [200, {}, ["Coming soon"]] }, via: :get
match 'photos/:id', to: PhotoRackApp, via: :get
# Yes, controller actions are just rack endpoints
match 'photos/:id', to: PhotosController.action(:show), via: :get

Поскольку запросы с различными HTTP-методами для одного действия могут иметь последствия для безопасности, необходимо либо указать действия в параметре via, либо использовать один из HttpHelpers вместо match

Параметры

Все параметры, не указанные здесь, передаются в качестве параметров в URL.

:controller

Контроллер маршрута.

:action

Метод контроллера маршрута.

:param

Заменяет стандартный идентификатор ресурса :id (имя динамического сегмента, используемого для генерации маршрутов). Этот сегмент можно получить в контроллере, используя params[<:param>]. В маршрутизаторе:

resources :user, param: :name

Можно переопределить ActiveRecord::Base#to_param связанной модели для построения URL:

class User < ActiveRecord::Base
  def to_param
    name
  end
end

user = User.find_by(name: 'Phusion') user_path(user) # => “/users/Phusion”

:path

Префикс пути для маршрутов.

:module

Пространство имён для :controller.

match 'path', to: 'c#a', module: 'sekret', controller: 'posts', via: :get
# => Sekret::PostsController

См. Scoping#namespace для эквивалента области действия.

:as

Имя, используемое для генерации вспомогательных методов маршрутизации.

:via

Разрешённые HTTP-методы для маршрута.

match 'path', to: 'c#a', via: :get
match 'path', to: 'c#a', via: [:get, :post]
match 'path', to: 'c#a', via: :all

:to

Указывает на конечную точку Rack. Может быть объектом, который отвечает на call , или строкой, представляющей метод контроллера.

match 'path', to: 'controller#action', via: :get
match 'path', to: -> (env) { [200, {}, ["Success!"]] }, via: :get
match 'path', to: RackApp, via: :get

:on

Сокращение для обертывания маршрутов в определённый контекст REST. Допустимые значения — :member, :collection, и :new. Используйте только внутри блока resource(s). Например:

resource :bar do
  match 'foo', to: 'c#a', on: :member, via: [:get, :post]
end

Эквивалентно:

resource :bar do
  member do
    match 'foo', to: 'c#a', via: [:get, :post]
  end
end

:constraints

Ограничивает параметры с помощью хеша регулярных выражений или объекта, который отвечает на matches?. Кроме того, можно указать ограничения, отличные от пути, с помощью любого объекта, который отвечает на === (например, String, Array, Range и т. д.).

match 'path/:id', constraints: { id: /[A-Z]\d{5}/ }, via: :get

match 'json_only', constraints: { format: 'json' }, via: :get

class Whitelist
  def matches?(request) request.remote_ip == '1.2.3.4' end
end
match 'path', to: 'c#a', constraints: Whitelist.new, via: :get

См. Scoping#constraints для дополнительных примеров с эквивалентом области действия.

:defaults

Устанавливает значения по умолчанию для параметров.

# Sets params[:format] to 'jpg' by default
match 'path', to: 'c#a', defaults: { format: 'jpg' }, via: :get

См. Scoping#defaults для эквивалента области действия.

:anchor

Булево значение для привязки шаблона match. По умолчанию значение равно true. Если значение равно false, шаблон соответствует любому запросу, начинающемуся с заданного пути.

# Matches any request starting with 'path'
match 'path', to: 'c#a', anchor: false, via: :get

:format

Позволяет указать значение по умолчанию для необязательного сегмента format или отключить его, указав false.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 594
        def mount(app, options = nil)
          if options
            path = options.delete(:at)
          elsif Hash === app
            options = app
            app, path = options.find { |k, _| k.respond_to?(:call) }
            options.delete(app) if app
          end

          raise ArgumentError, "A rack application must be specified" unless app.respond_to?(:call)
          raise ArgumentError, "            Must be called with mount point

              mount SomeRackApp, at: "some_route"
              or
              mount(SomeRackApp => "some_route")
".strip_heredoc unless path

          rails_app = rails_app? app
          options[:as] ||= app_name(app, rails_app)

          target_as       = name_for_action(options[:as], path)
          options[:via] ||= :all

          match(path, options.merge(:to => app, :anchor => false, :format => false))

          define_generate_prefix(app, target_as) if rails_app
          self
        end

Подключает приложение на основе Rack для использования в приложении.

mount SomeRackApp, at: "some_route"

В качестве альтернативы:

mount(SomeRackApp => "some_route")

Для параметров см. match, так как mount использует его внутри.

Все подключённые приложения поставляются с вспомогательными методами маршрутизации для доступа к ним. Эти вспомогательные методы названы в соответствии с указанным классом, поэтому для приведенного выше примера вспомогательные методы называются some_rack_app_path или some_rack_app_url. Чтобы настроить имя этого вспомогательного метода, используйте параметр :as:

mount(SomeRackApp => "some_route", as: "exciting")

Это сгенерирует вспомогательные методы exciting_path и exciting_url , которые можно использовать для перехода к этому подключённому приложению.