元数据文件 API 参考
本节文档涵盖了**元数据文件约定**。可以通过向路由段添加特殊的元数据文件来定义基于文件的元数据。
每个文件约定都可以使用静态文件(例如 opengraph-image.jpg
)或使用代码生成文件的动态变体(例如 opengraph-image.js
)来定义。
定义文件后,Next.js 会自动提供文件服务(在生产环境中使用哈希进行缓存)并使用正确的元数据更新相关的头部元素,例如资产的 URL、文件类型和图像大小。
了解一下:
- 特殊的路由处理程序,例如
sitemap.ts
、opengraph-image.tsx
和icon.tsx
以及其他元数据文件默认情况下会被缓存。- 如果与
middleware.ts
一起使用,请配置匹配器以排除元数据文件。
favicon、icon 和 apple-icon
Favicon、Icon 和 Apple Icon 文件约定的 API 参考。
manifest.json
manifest.json 文件的 API 参考。
opengraph-image 和 twitter-image
Open Graph 图像和 Twitter 图像文件约定的 API 参考。
robots.txt
robots.txt 文件的 API 参考。
sitemap.xml
sitemap.xml 文件的 API 参考。
这有帮助吗?