@ampproject/toolbox-cors

中文文档
2.10.1发布于 2024/06/14Apache-2.0CommonJS近 30 天下载 2137

执行AMP CORS协议的快取中间软件

中文使用文档
文档目录9 节
  1. 安装
  2. 使用量
  3. 按来源过滤
  4. 来源核查
  5. 允许刻录
  6. 允许 AMP- 重定向到
  7. 日志
  8. 电子邮件模式
  9. 示例

AMP CMORS 中间软件

npm version

AMP CORS 中间软件添加了 CORS 和 AMP CORS 文档 所有 CORS 信头 aMP运行时间启动的请求。 中间软件只添加这些标题,如果 __amp_source_origin 查询参数已存在。 所有其他请求保持不变.

安装

通过 :

npm install @ampproject/toolbox-cors --save

使用量

以下是使用 快递数字 :

const express = require('express');
const ampCors = require('@ampproject/toolbox-cors');

const app = express();

// That's it!
app.use(ampCors());
...

请注意,AMP CORS并不依赖于Express,而是基于Node的HTTP请求和 反应对象.

按来源过滤

您可以额外过滤源代码的请求 。 例如:

app.use(ampCors({
  sourceOriginPattern: /https:\/\/ampbyexample\.com$/
}));

这将只允许请求使用 https://amp.dev 设置为源代码。 所有其他来源的请求 将收到 403 反应,

来源核查

默认情况下, AMP CMORS 中间软件将只允许 AMP Caches 提出的请求 https://cdn.ampproject.org/caches.json 页面存档备份,存于互联网档案馆。所有其他 来源将收到 403 反应。 要允许来自所有来源的请求, 请禁用此选项 通过 verifyOrigin 选项 :

app.use(ampCors({
  verifyOrigin: false
}));

允许刻录

默认情况下, AMP CORS 中间软件将允许 日历模式 用于请求AMP CORS. 要禁用此选项, 设置 allowCredentials 改为 false。 。 。 .

app.use(ampCors({
  allowCredentials: false
}));
// => will not set "Access-Control-Allow-Credentials", "true"

允许 AMP- 重定向到

默认情况下,AMP CORS 中间软件将允许通过 AMP - 直接到设置 enableAmpRedirectTo 改为 false。 。 。 .

app.use(ampCors({
  enableAmpRedirectTo: false
}));
// Access-Control-Expose-Headers: AMP-Redirect-To

日志

对于调试请求,您可以通过 verbose 选项 :

app.use(ampCors({
  verbose: false
}));

电子邮件模式

Gmail已经 aMP CORS的具体要求。您可以通过 email option数字 :

app.use(ampCors({
  email: true
}));

说明: 网站的默认 AMP CMORS 模式与电子邮件 CORS 模式相兼容(不再支持只支持来源验证). 如果你想支持两者,默认启用电子邮件模式是安全的.

示例

见 表达式.js 样本执行。 将增加AMP CORS标题的两种情况:

  1. 如果 __amp_source_origin 查询参数与 AMP-SAME-ORIGIN 页眉 :
$ curl --header "AMP-SAME-ORIGIN: true" -I "http://localhost:3000/items?__amp_source_origin=https://localhost:3000"
HTTP/1.1 200 OK
X-Powered-By: Express
Access-Control-Allow-Origin: https://localhost:3000
Content-Type: application/json; charset=utf-8
...
  1. 如果 __amp_source_origin 查询参数与 Origin 页眉 :
$ curl --header "Origin: https://amp-dev.cdn.ampproject.org" -I "http://localhost:3000/items?__amp_source_origin=https://localhost:3000"
HTTP/1.1 200 OK
Access-Control-Allow-Origin: https://amp-dev.cdn.ampproject.org
Content-Type: application/json; charset=utf-8
...

在所有其他情况下,将不设置 CORS 标题 .

$ curl -I localhost:3000/items
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
...

版本与发布记录

@ampproject/toolbox-cors 共发布 43 个版本,首次发布于 2019/06/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.10.1latest2024/06/142 年前
2.10.02024/06/142 年前
2.9.02022/06/244 年前
3.0.0-canary.2canary2022/01/124 年前
2.8.02021/05/315 年前
2.8.0-canary.152021/03/315 年前

其他发布通道:beta → 1.1.0-beta.0,alpha → 2.7.0-alpha.1,canary → 3.0.0-canary.2。

关于 @ampproject/toolbox-cors 的常见问题

@ampproject/toolbox-cors 是什么?

执行AMP CORS协议的快取中间软件

如何安装 @ampproject/toolbox-cors?

在项目目录运行 npm install @ampproject/toolbox-cors,或使用 pnpm add / yarn add / bun add。

@ampproject/toolbox-cors 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/ampproject__toolbox-cors 是否存在。

@ampproject/toolbox-cors 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@ampproject/toolbox-cors 可以商用吗?

@ampproject/toolbox-cors 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@ampproject/toolbox-cors 的下载量有多少?

根据 npm 官方下载统计,@ampproject/toolbox-cors 在 2026/10/06 – 2026/11/04 这 30 天内被下载 2,137 次,日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ampproject/toolbox-cors 还在维护吗?

最新版本 2.10.1 发布于 2024/06/14(2 年前);至今共发布 43 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/06/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。