Ruby on Rails 中的 OG 图片
使用 FastOG 基于订阅的动态 API 在 Ruby on Rails 中生成 OG 图片——需要动态 API 订阅（请在仪表板中创建您的 API 密钥）。先在免费的 OG 图片测试器中预览，然后通过 HMAC 签名的 URL 从您的 Rails 应用中渲染动态 Open Graph 图片。
快速开始
1. 创建签名者服务
ruby
# app/services/fastog_signer.rb
class QuickogSigner
def self.generate_signed_og_url(params, options = {})
base_url = options[:base_url] || ENV.fetch("FASTOG_BASE_URL", "https://fastog.com/api/v1/og")
api_key = options[:api_key] || ENV.fetch("FASTOG_API_KEY")
hmac_secret = options[:hmac_secret] || ENV.fetch("FASTOG_HMAC_SECRET")
raise "Missing FASTOG_API_KEY or FASTOG_HMAC_SECRET" unless api_key && hmac_secret
all = params.merge(key: api_key)
pairs = all.flat_map do |k, v|
Array(v).sort.map { |vv| "#{enc(k)}=#{enc(vv)}" }
end
canonical = pairs.sort.join("&")
signature = OpenSSL::HMAC.hexdigest("SHA256", hmac_secret, "GET/api/v1/og\n#{canonical}")
"#{base_url}?#{URI.encode_www_form(all.merge(s: signature))}"
end
def self.enc(s)
s.to_s.gsub(/[^A-Za-z0-9\-._~]/) { |c| c.bytes.map { |b| "%%%02X" % b }.join }
end
private_class_method :enc
end
为什么需要自定义 enc？ 它使用大写十六进制进行百分号编码，仅保留 -._~ 中的非保留字符——因此空格会变成 %20，而绝不会是 +，这与服务器的 rawurlencode 保持一致。如果您改用 CGI.escape 或 URI.encode_www_form_component，两者都会将空格输出为 +：请先使用 .gsub('+', '%20') 进行规范化。
2. 配置
ruby
# config/application.rb
config.fastog = ActiveSupport::OrderedOptions.new
config.fastog.api_key = ENV.fetch("FASTOG_API_KEY", nil)
config.fastog.hmac_secret = ENV.fetch("FASTOG_HMAC_SECRET", nil)
config.fastog.base_url = ENV.fetch("FASTOG_BASE_URL", "https://fastog.com/api/v1/og")
bash
# .env
FASTOG_API_KEY=sk_your_full_api_key_here
FASTOG_HMAC_SECRET=your_64_char_hex_secret_here
控制器
ruby
# app/controllers/blog_controller.rb
class BlogController < ApplicationController
def show
@post = Post.find_by!(slug: params[:slug])
@og_image_url = QuickogSigner.generate_signed_og_url(
template: "blog",
title: @post.title,
subtitle: @post.excerpt,
author: @post.author.name
)
end
end
视图
erb
<!-- app/views/blog/show.html.erb -->
<% content_for :head do %>
<meta property="og:image" content="<%= @og_image_url %>" />
<meta property="og:title" content="<%= @post.title %>" />
<meta property="og:description" content="<%= @post.excerpt %>" />
<% end %>
<article>
<h1><%= @post.title %></h1>
<p><%= @post.excerpt %></p>
</article>
布局
erb
<!-- app/views/layouts/application.html.erb -->
<head>
<%= yield :head %>
</head>
辅助工具
ruby
# app/helpers/fastog_helper.rb
module QuickogHelper
def og_image_url(template:, **params)
QuickogSigner.generate_signed_og_url({ template: template }.merge(params))
end
end
erb
<!-- In view -->
<meta property="og:image" content="<%= og_image_url(template: 'blog', title: @post.title) %>" />
电商示例
ruby
# app/controllers/products_controller.rb
class ProductsController < ApplicationController
def show
@product = Product.find(params[:id])
@og_image_url = QuickogSigner.generate_signed_og_url(
template: "ecommerce",
title: @product.name,
price: @product.formatted_price,
image: @product.image_url
)
end
end
博客文章示例
ruby
# app/controllers/users_controller.rb
class UsersController < ApplicationController
def show
@user = User.find_by!(username: params[:username])
@og_image_url = QuickogSigner.generate_signed_og_url(
template: "blog",
title: @user.name,
subtitle: @user.bio,
author: @user.name
)
end
end
API 端点
ruby
# config/routes.rb
get "api/og", to: "api/og#generate"
ruby
# app/controllers/api/og_controller.rb
module Api
class OgController < ApplicationController
skip_before_action :verify_authenticity_token
def generate
title = params[:title]
template = params[:template] || "default"
unless title
return render json: { error: "Missing title" }, status: :bad_request
end
og_image_url = QuickogSigner.generate_signed_og_url(
template: template,
title: title
)
render json: { ogImageUrl: og_image_url }
end
end
end
Turbo/Hotwire
erb
<!-- app/views/blog/_post.html.erb -->
<%= turbo_frame_tag "post_#{@post.id}" do %>
<meta property="og:image" content="<%= og_image_url(template: 'blog', title: @post.title) %>" />
<h2><%= link_to @post.title, blog_path(@post) %></h2>
<% end %>
常见陷阱
签名错误的消息
❌ 错误："GET/api/v1/og#{canonical}" — 缺少换行分隔符。
✅ 正确："GET/api/v1/og\n#{canonical}" — 方法 + 路径、换行，然后是规范化查询。
将 key 排除在签名之外
❌ 错误：仅对内容参数进行签名，并在之后将 key 追加到 URL。
✅ 正确：在构建规范化查询之前，将 key 合并到参数中，并出现在最终 URL 中。
401 missing_signature / invalid_signature
missing_signature（401）表示 URL 中缺少 key 或 s。invalid_signature（401）表示规范化不匹配 — 请确认签名消息中的换行、两侧使用相同的 hmac_secret，以及 enc 将空格百分号编码为 %20（绝不能是 +）。
暴露 HMAC 密钥
切勿在前端 JavaScript 或客户端代码中暴露 FASTOG_HMAC_SECRET。