Next.js Pages Router 中的 OG 圖片
使用 FastOG 的訂閱制 Dynamic API 在 Next.js Pages Router 中生成 OG 圖片 — 需訂閱 Dynamic API(請在儀表板中建立您的 API 金鑰)。使用免費的 OG 圖片測試工具(Free OG Image Tester)預覽任何範本,然後在您的 Pages Router 路由中,以 HMAC 簽署的 URL 串接動態 Open Graph 圖片。
設定
1. 建立簽署者工具
javascript
// lib/og-image-signer.js
import crypto from "crypto";
export function generateSignedOgUrl(params, options = {}) {
const {
baseUrl = "https://fastog.com/api/v1/og",
apiKey = process.env.FASTOG_API_KEY,
hmacSecret = process.env.FASTOG_HMAC_SECRET,
} = options;
if (!apiKey || !hmacSecret) {
throw new Error("Missing FASTOG_API_KEY or FASTOG_HMAC_SECRET");
}
// RFC-3986 percent-encoding: keep A-Za-z0-9-._~
const enc = (s) =>
encodeURIComponent(s).replace(
/[!'()*]/g,
(c) => "%" + c.charCodeAt(0).toString(16).toUpperCase(),
);
// Every query param except the signature, INCLUDING key
const all = { ...params, key: apiKey };
// Canonical query: sorted enc(key)=enc(value) pairs joined with &
const pairs = [];
for (const [k, v] of Object.entries(all)) {
for (const vv of Array.isArray(v) ? v : [v]) {
pairs.push(`${enc(k)}=${enc(vv)}`);
}
}
pairs.sort();
const canonical = pairs.join("&");
// Sign the exact bytes the server will verify
const signature = crypto
.createHmac("sha256", hmacSecret)
.update(`GET/api/v1/og\n${canonical}`)
.digest("hex");
// Build the URL from the same pairs so bytes match the canonical form
const url = new URL(baseUrl);
for (const [k, v] of Object.entries(all)) {
for (const vv of Array.isArray(v) ? v : [v]) {
url.searchParams.append(Array.isArray(v) ? `${k}[]` : k, vv);
}
}
url.searchParams.set("s", signature);
return url.toString();
}
2. 環境變數
bash
# .env.local
FASTOG_API_KEY=sk_your_full_api_key_here
FASTOG_HMAC_SECRET=your_64_char_hex_secret_here
靜態網站生成(SSG)
typescript
// pages/blog/[slug].tsx
import Head from "next/head";
import { generateSignedOgUrl } from "@/lib/og-image-signer";
export default function BlogPost({ post, ogImageUrl }) {
return (
<>
<Head>
<meta property="og:image" content={ogImageUrl} />
<meta property="og:title" content={post.title} />
<meta property="og:description" content={post.excerpt} />
</Head>
<article>
<h1>{post.title}</h1>
<p>{post.excerpt}</p>
</article>
</>
);
}
export async function getStaticPaths() {
const posts = await getAllPosts();
return {
paths: posts.map((post) => ({ params: { slug: post.slug } })),
fallback: "blocking",
};
}
export async function getStaticProps({ params }) {
const post = await getPost(params.slug);
const ogImageUrl = generateSignedOgUrl({
template: "blog",
title: post.title,
subtitle: post.excerpt,
});
return {
props: {
post,
ogImageUrl,
},
revalidate: 3600,
};
}
伺服器端渲染(SSR)
typescript
// pages/products/[id].tsx
import Head from "next/head";
import { generateSignedOgUrl } from "@/lib/og-image-signer";
export default function Product({ product, ogImageUrl }) {
return (
<>
<Head>
<meta property="og:image" content={ogImageUrl} />
<meta property="og:title" content={product.name} />
</Head>
<main>
<h1>{product.name}</h1>
<p>{product.price}</p>
</main>
</>
);
}
export async function getServerSideProps({ params }) {
const product = await getProduct(params.id);
const ogImageUrl = generateSignedOgUrl({
template: "ecommerce",
title: product.name,
price: product.price,
image: product.image,
});
return {
props: {
product,
ogImageUrl,
},
};
}
API 路由代理
typescript
// pages/api/og.ts
import type { NextApiRequest, NextApiResponse } from "next";
import { generateSignedOgUrl } from "@/lib/og-image-signer";
export default function handler(req: NextApiRequest, res: NextApiResponse) {
const { title, template = "default" } = req.query;
if (!title) {
return res.status(400).json({ error: "Missing title" });
}
const ogImageUrl = generateSignedOgUrl({
template: template as string,
title: title as string,
});
res.json({ ogImageUrl });
}
常見陷阱
錯誤的訊息格式
簽署的訊息是 GET/api/v1/og 加上一個換行符號,再加上正規化的查詢字串。
❌ 錯誤:GET/api/v1/og + path + apiKey 直接串接(缺少正規化查詢)
✅ 正確:GET/api/v1/og + \n + 排序後的 enc(key)=enc(value) 正規化鍵值對(包含 key)
簽署的位元組與傳送的內容不一致
請使用與簽署時相同的 enc(key)=enc(value) 鍵值對來建構最終 URL,否則伺服器會回傳 401 invalid_signature。