@gofynd/fp-signature

中文文档
2.0.1发布于 2025/09/24ISCTypeScriptESM + CJS近 30 天下载 2.1万

Fynd 平台的签名逻辑

中文使用文档
文档目录10 节
  1. 安装
  2. 如何使用
  3. 用于普通JS
  4. ES模块
  5. 浏览器
  6. 在邮递员处方
  7. 职能
  8. sign 函数
  9. RequestParam 对象
  10. 示例

FP 签名

Fynd 平台的签名逻辑

FP-Signature是一个多功能npm软件包,为Fynd平台请求提供签名逻辑. 这个软件包既支持CommonJS模块,也支持ES模块,它也伴随着一个网页捆绑,用于浏览器的直接使用.

安装

您可以通过 npm 安装 FP- 签名 :

npm install @gofynd/fp-signature

如何使用

用于普通JS

const { sign } = require("@gofynd/fp-signature");

ES模块

import { sign } from "@gofynd/fp-signature";

浏览器

<script src="https://cdn.jsdelivr.net/npm/@gofynd/fp-signature@{version}"></script>
<script>
    // FP-Signature library will be attached to the global window object
    FPSignature.sign();
</script>

在邮递员处方

在邮报上使用FP-Signature作为前言,包括 邮递员 prespect.js 在您 Postman 收藏的前文节中存档.

根据您的要求,在前缀中修改FP-Signature包版本.

职能

sign 函数

这个 sign 函数用于生成签名。 它需要两个参数: request 财务报告和审定财务报表 options。 。 。 .

它会直接返回签名字符串 .

库生成您请求的签名 。 将返回的签名字符串包含在 x-fp-signature 签名请求的页眉 .

说明编号: x-fp-date 时间戳是 所需经费 用于生成签名。 您必须将其包含在请求头或查询参数中 。 这个时间戳有助于防止回放攻击,被用在签名生成过程中. 时间戳应当采用ISO 8601格式,没有冒号,破折号,或毫秒(如:, 20240101T120000Z) (中文(简体) ).

type RequestParam = {
  method: string;
  host?: string;
  port?: number;
  path?: string;
  headers?: any;
  body?: any;
  doNotEncodePath?: boolean;
  doNotModifyHeaders?: boolean; 
};

type SigningOptions = {
    secret: string;
}

function sign(request : RequestParam, options: SigningOptions) : string {}

RequestParam 对象

这个 RequestParam 对象用于配置需要签名的 HTTP 请求的细节.

属性 :

  • method数字 : (字符串,需要) - 请求的HTTP方法(例如"GET","POST").

  • host数字 : (弦,可选) - 服务器主机 实例: developer.mozilla.org:4097, (中文(简体) ), api.fyndx5.de

  • port数字 : (数目,可选) - 服务器的端口号码.

  • path数字 : (弦,可选) - 有查询参数的请求 URL 的路径( 如果有的话) .

  • headers数字 : (对象,可选) - 请求的自定义信头。 排除常见的默认信头,删除,获取,头,帖,放,补. 说明编号: x-fp-date 签名生成需要页眉.

  • body数字 : (任何,可选) -请求的内容.

  • doNotEncodePath数字 : (boolean,可选) - 如果正确, 路径将不会被编码为 URL .

  • doNotModifyHeaders数字 : (boolean,可选) - 如果是真的,在签名时不会修改标题.

示例

const requestToSign = {
    method: "GET",
    host: "api.fynd.com",
    path: "/service/application/configuration/v1.0/application?queryParam=value",
    headers: {
      Authorization: "Bearer <authorizationToken>",
      "x-currency-code": "INR",
      "x-fp-date": new Date().toISOString().replace(/[:\-]|\.\d{3}/g, "")
    },
};

示例

// For Common JS
// const {sign} = require("@gofynd/fp-signature")

// For ES Module
import {sign} from "@gofynd/fp-signature";

const requestToSign = {
  method: "GET",
  host: "api.fynd.com",
  path: "/service/application/configuration/v1.0/application",
  headers: {
    Authorization: "Bearer <authorizationToken>",
    "x-currency-code": "INR",
    "x-fp-date": new Date().toISOString().replace(/[:\-]|\.\d{3}/g, "")
  },
};

const signature = sign(requestToSign, { secret: 'your-secret-key' });

// Use the signature as needed - add to headers, query params, etc.
console.log('Generated signature:', signature);

版本与发布记录

@gofynd/fp-signature 共发布 10 个版本,首次发布于 2023/08/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.1latest2025/09/241.1 年前
2.0.1-beta.02025/09/241.1 年前
2.0.02025/09/211.2 年前
1.0.22025/07/081.4 年前
1.0.12023/12/152 年前
1.0.02023/11/033 年前

关于 @gofynd/fp-signature 的常见问题

@gofynd/fp-signature 是什么?

Fynd 平台的签名逻辑

如何安装 @gofynd/fp-signature?

在项目目录运行 npm install @gofynd/fp-signature,或使用 pnpm add / yarn add / bun add。

@gofynd/fp-signature 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gofynd/fp-signature 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gofynd/fp-signature 可以商用吗?

@gofynd/fp-signature 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gofynd/fp-signature 的下载量有多少?

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

@gofynd/fp-signature 还在维护吗?

最新版本 2.0.1 发布于 2025/09/24(1.1 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/08/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。