Ruby Sinatra动态创建端点：无需重启服务器读取文件方案

核心思路 #

放弃生成静态app.rb的方案，改为让Sinatra动态加载请求响应配置文件，通过文件监听或Kubernetes配置联动实现配置更新时无需重启服务/容器。核心是将路由规则与服务代码解耦，把端点定义存入外部配置文件，由程序实时读取或按需重载。

具体实现步骤 #

1. 定义配置文件格式 #

用JSON或纯文本存储端点映射，示例endpoints.json：

{
  "/api/users": {
    "get": {
      "status": 200,
      "body": "[{\"id\":1,\"name\":\"Alice\"}]",
      "headers": {"Content-Type": "application/json"}
    }
  },
  "/api/orders": {
    "post": {
      "status": 201,
      "body": "{\"message\":\"Order created successfully\"}"
    }
  }
}

2. 编写动态路由的Sinatra服务 #

通过通用路由匹配+配置重载机制实现热更新，无需硬编码路由：

require 'sinatra/base'
require 'json'
require 'listen'
require 'mutex_m'

class DynamicAPI < Sinatra::Base
  include Mutex_m
  @endpoints = {}

  # 安全加载配置（线程锁避免并发问题）
  def self.load_endpoints
    synchronize do
      config_path = ENV.fetch('ENDPOINTS_CONFIG', './endpoints.json')
      @endpoints = JSON.parse(File.read(config_path))
      puts "Reloaded #{@endpoints.size} endpoints from #{config_path}"
    end
  end

  # 启动配置文件监听
  def self.start_config_listener
    config_path = ENV.fetch('ENDPOINTS_CONFIG', './endpoints.json')
    listener = Listen.to(File.dirname(config_path), only: [File.basename(config_path)]) do |modified|
      load_endpoints unless modified.empty?
    end
    listener.start
  end

  # 初始化加载配置并启动监听
  load_endpoints
  start_config_listener

  # 通用HTTP方法路由处理
  ['get', 'post', 'put', 'delete', 'patch'].each do |method|
    send(method, '*') do |path|
      endpoint_conf = @endpoints.dig(path, method)
      if endpoint_conf
        status endpoint_conf['status'] || 200
        headers endpoint_conf['headers'] || {}
        body endpoint_conf['body'] || ''
      else
        status 404
        body "{\"error\":\"Endpoint not found\"}"
      end
    end
  end
end

run DynamicAPI

3. Puma服务器配置 #

确保线程安全并支持配置重载，示例config/puma.rb：

threads_count = ENV.fetch("MAX_THREADS") { 5 }.to_i
threads threads_count, threads_count

port ENV.fetch("PORT") { 3000 }
environment ENV.fetch("RACK_ENV") { "production" }

# 工作进程启动时重新加载配置，适配Puma多进程模式
on_worker_boot do
  DynamicAPI.load_endpoints
end

Kubernetes部署适配 #

将配置文件挂载为ConfigMap，实现配置更新时自动同步到容器，无需重新部署：

示例Deployment与ConfigMap #

apiVersion: apps/v1
kind: Deployment
metadata:
  name: dynamic-api
spec:
  replicas: 2
  selector:
    matchLabels:
      app: dynamic-api
  template:
    metadata:
      labels:
        app: dynamic-api
    spec:
      containers:
      - name: api
        image: your-ruby-sinatra-image:latest
        ports:
        - containerPort: 3000
        env:
        - name: ENDPOINTS_CONFIG
          value: /config/endpoints.json
        volumeMounts:
        - name: config-volume
          mountPath: /config
      volumes:
      - name: config-volume
        configMap:
          name: dynamic-api-config
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: dynamic-api-config
data:
  endpoints.json: |
    {
      "/api/users": {
        "get": {
          "status": 200,
          "body": "[{\"id\":1,\"name\":\"Alice\"}]",
          "headers": {"Content-Type": "application/json"}
        }
      }
    }

实时配置更新优化 #

如果需要Kubernetes ConfigMap更新后立即生效，可添加configmap-reload sidecar容器，监听配置变化并发送信号触发Sinatra重载：

# 在Deployment的containers中添加以下内容
- name: config-reloader
  image: jimmidyson/configmap-reload:v0.5.0
  args:
  - --volume-dir=/config
  - --webhook-url=http://localhost:3000/reload-config
  volumeMounts:
  - name: config-volume
    mountPath: /config

同时在Sinatra服务中添加重载接口：

post '/reload-config' do
  DynamicAPI.load_endpoints
  status 200
  body "{\"message\":\"Config reloaded\"}"
end

注意事项 #

• 线程安全：加载配置时必须加线程锁，避免多线程读取到不完整的配置数据
• 生产环境：可关闭文件监听，改用Kubernetes滚动更新或发送SIGUSR1信号给Puma触发工作进程重启重载配置
• 配置校验：加载配置时加入格式校验逻辑，避免无效配置导致服务崩溃

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