如何设计Rails API路由将API密钥嵌入路径而非参数/请求头？

要实现你需要的路径格式，核心是把API密钥作为路径参数嵌入到/api/v1/层级之后，再嵌套后续的资源路由。下面是具体的路由设计方案：

基础路由配置 #

在config/routes.rb中，用scope统一包裹需要携带API密钥的路由，这样所有嵌套路由都会自动带上密钥参数，写法更简洁：

Rails.application.routes.draw do
  namespace :api do
    namespace :v1 do
      # 捕获路径中的API密钥，参数名为api_connection_key
      scope ':api_connection_key' do
        # 处理根路径 /api/v1/:api_connection_key/
        root to: 'base#index'

        # 生成messages的RESTful路由，对应路径 /api/v1/:api_connection_key/messages
        resources :messages

        # 生成authors与books的嵌套路由，对应 /api/v1/:api_connection_key/authors/123/books
        resources :authors do
          resources :books
        end
      end
    end
  end
end

关键说明 #

1. 参数获取：:api_connection_key会自动存入params哈希，控制器中可直接通过params[:api_connection_key]拿到密钥值。
2. 控制器映射：namespace :api和namespace :v1会自动对应app/controllers/api/v1/目录下的控制器，比如messages路由对应Api::V1::MessagesController，完全匹配你的需求。
3. RESTful路由支持：resources :messages会生成标准的index/show/create等动作路由，所有路径都会自动带上API密钥前缀。

可选：添加API密钥格式约束 #

如果需要限制密钥格式（比如必须是8位十六进制字符串），可以给scope加约束规则，过滤无效请求：

scope ':api_connection_key', constraints: { api_connection_key: /\A[0-9a-f]{8}\z/i } do
  # 嵌套路由内容
end

不符合格式的密钥会直接返回404。

控制器中使用密钥示例 #

以MessagesController为例，获取密钥并处理业务的代码示例：

class Api::V1::MessagesController < Api::V1::BaseController
  def index
    api_key = params[:api_connection_key]
    # 后续逻辑：验证密钥、查询数据等
  end
end

内容的提问来源于stack exchange，提问作者equivalent8