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

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

Проверить, определён ли следующий именованный маршрут.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 610
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 :users, param: :name

The `users` resource here will have the following routes generated for it:

    GET       /users(.:format)
    POST      /users(.:format)
    GET       /users/new(.:format)
    GET       /users/:name/edit(.:format)
    GET       /users/:name(.:format)
    PATCH/PUT /users/:name(.:format)
    DELETE    /users/:name(.:format)

You can override `ActiveRecord::Base#to_param` of a related model to
construct a 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

See `Scoping#namespace` for its scope equivalent.

: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

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

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

Is equivalent to:

    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 PermitList
      def matches?(request) request.remote_ip == '1.2.3.4' end
    end
    match 'path', to: 'c#a', constraints: PermitList.new, via: :get

See `Scoping#constraints` for more examples with its scope equivalent.

:defaults

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

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

See `Scoping#defaults` for its scope equivalent.

: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 632
        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, <<~MSG unless path
            Must be called with mount point

              mount SomeRackApp, at: "some_route"
              or
              mount(SomeRackApp => "some_route")
          MSG

          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, { to: app, anchor: false, format: false }.merge(options))

          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, которые можно использовать для перехода к этому подключённому приложению.