元数据文件 API 参考
元数据文件约定的 API 文档。
本文档部分介绍元数据文件约定。可以通过向路由段添加特殊的元数据文件来定义基于文件的元数据。
每个文件约定既可以使用静态文件定义(例如 opengraph-image.jpg),也可以使用通过代码生成文件的动态变体(例如 opengraph-image.js)。
文件定义后,Next.js 会自动提供该文件(在生产环境中会附带哈希以用于缓存),并使用正确的元数据更新相关的 head 元素,例如资源的 URL、文件类型和图片尺寸。
小知识:
- 页面的显式
openGraph.images或twitter.images元数据会覆盖相应的基于文件的图片,包括同一段中的文件。请参阅图片优先级。- 特殊的 Route Handler,如
sitemap.ts、opengraph-image.tsx和icon.tsx,以及其他元数据文件默认都会被缓存。- 如果与
proxy.ts一起使用,请配置 matcher以排除元数据文件。