配置幂等性头部

以 Markdown 格式查看
专业版和企业版功能

此功能仅适用于专业版和企业版计划。如需开始使用,请联系 support@buildwithfern.com

对于您已配置为幂等的端点,Fern 的 SDK 允许用户指定幂等性头部以进行安全的请求重试。通常这些头部包括 Idempotency-Key,但您也可以指定其他头部。

生成的 SDK 行为

生成的 SDK 仅为标记为幂等的端点暴露幂等性头部作为参数,确保用户明确知道哪些调用是幂等的。

1const response = await client.transactions.send({
2 amount: 100,
3 currency: "usd",
4}, {
5 idempotencyKey: "64099353-b48b-4dcd-98b7-74df1cc57933"
6});

设置幂等性头部

配置您的 API 使用的幂等性头部,然后将个别端点标记为幂等:

openapi.yml
1x-fern-idempotency-headers:
2 - header: IDEMPOTENCY-KEY
3 name: idempotency_key
4
5paths:
6 /plants:
7 post:
8 x-fern-idempotent: true

有关完整的配置详细信息,请参阅您的 API 定义格式的文档: