SDK 变量（OpenAPI） | Fern Documentation

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

x-fern-sdk-variables:
  gardenId:
    type: string
    description: The unique identifier for your garden
  zoneId:
    type: string
    description: The zone within the garden
paths:
  /gardens/{gardenId}/zones/{zoneId}/plants:
    get:
      operationId: list_plants_in_zone
      parameters:
        - name: gardenId
          in: path
          required: true
          x-fern-sdk-variable: gardenId
          schema:
            type: string
        - name: zoneId
          in: path
          required: true
          x-fern-sdk-variable: zoneId
          schema:
            type: string

SDK 使用

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

const client = new PlantClient({
  gardenId: "garden_123",
  zoneId: "zone_456",
  apiKey: "your-api-key"
});
const plants = await client.listPlantsInZone();