SDK 变量

x-fern-sdk-variables 扩展允许您定义在 SDK 客户端初始化时设置一次的变量，并在所有端点调用的路径参数中自动使用。这对于在许多端点路径中出现的通用参数（如租户 ID、组织 ID 或环境标识符）非常有用。

SDK 变量在 TypeScript (v2.6.3+)、Python (v4.24.0+) 和 Java (v3.6.3+) 中受支持。仅支持字符串类型。

配置

使用 x-fern-sdk-variables 在文档级别定义变量，然后使用 x-fern-sdk-variable 将路径参数标记为变量：

openapi.yml

1 x-fern-sdk-variables:
2   gardenId:
3     type: string
4     description: The unique identifier for your garden
5   zoneId:
6     type: string
7     description: The zone within the garden
8 
9 paths:
10   /gardens/{gardenId}/zones/{zoneId}/plants:
11     get:
12       operationId: list_plants_in_zone
13       parameters:
14         - name: gardenId
15           in: path
16           required: true
17           x-fern-sdk-variable: gardenId
18           schema:
19             type: string
20         - name: zoneId
21           in: path
22           required: true
23           x-fern-sdk-variable: zoneId
24           schema:
25             type: string

SDK 使用

变量成为必需的构造函数参数，而不是传递给单个方法调用：

1 const client = new PlantClient({
2   gardenId: "garden_123",
3   zoneId: "zone_456",
4   apiKey: "your-api-key"
5 });
6 
7 const plants = await client.listPlantsInZone();

1	x-fern-sdk-variables:
2	gardenId:
3	type: string
4	description: The unique identifier for your garden
5	zoneId:
6	type: string
7	description: The zone within the garden
8
9	paths:
10	/gardens/{gardenId}/zones/{zoneId}/plants:
11	get:
12	operationId: list_plants_in_zone
13	parameters:
14	- name: gardenId
15	in: path
16	required: true
17	x-fern-sdk-variable: gardenId
18	schema:
19	type: string
20	- name: zoneId
21	in: path
22	required: true
23	x-fern-sdk-variable: zoneId
24	schema:
25	type: string

1	const client = new PlantClient({
2	gardenId: "garden_123",
3	zoneId: "zone_456",
4	apiKey: "your-api-key"
5	});
6
7	const plants = await client.listPlantsInZone();