配置全局头部

以 Markdown 格式查看

如果您的 API 在每个请求(或大部分请求)中都需要特定的头部,您可以将它们配置为 全局头部。Fern 将生成一个 SDK,在客户端构造函数中接受这些头部一次,并自动将它们包含在所有 API 调用中。

生成的 SDK 行为

一旦您配置了全局头部,Fern 会生成一个 SDK,将头部值作为构造函数参数接受:

1import os
2
3class Client:
4
5 def __init__(self, *, apiKey: str):

SDK 用户只需提供一次值,生成的 SDK 会自动将头部包含在所有请求中。

设置全局头部

Fern 会自动识别在每个请求或大部分请求中使用的头部,并将它们标记为全局头部。您可以在 API 定义中手动配置额外的全局头部:

openapi.yml
1x-fern-global-headers:
2 - header: custom_api_key
3 name: api_key
4 - header: userpool_id
5 optional: true

您还可以在全局头部上固定一个默认值,这样当调用者不提供值时,SDK 会自动发送它。

有关完整的配置详细信息,请参阅 OpenAPI 中的全局头部