服务器 URL 模板化

生成的 SDK 行为

Fern 生成一个环境模块，它暴露了每个命名服务器的默认 URL。SDK 用户可以选择预定义的环境或传递自定义 URL 字符串。

Python

Java

生成的 SDK 暴露了一个 Environment 类：

environment.py

1 class MyApiEnvironment:
2     REGIONAL_API_SERVER = {
3         "base": "https://api.example.com/v1",
4         "auth": "https://auth.example.com",
5     }

SDK 用户可以在构造客户端时覆盖基础 URL：

1 from my_api import MyApiClient
2 
3 # 使用默认环境
4 # → https://api.example.com/v1
5 client = MyApiClient()
6 
7 # 通过 URL 变量指定特定区域和环境
8 # → https://api.eu-west-1.staging.example.com/v1
9 client = MyApiClient(
10     region="eu-west-1",
11     environment="staging",
12 )
13 
14 # 或者提供自定义基础 URL
15 # → https://api.us-west-2.staging.example.com/v1
16 client = MyApiClient(
17     base_url="https://api.us-west-2.staging.example.com/v1",
18 )

设置服务器 URL 模板化

在你的 API 定义中定义 URL 模板变量，并为不自定义变量的 SDK 用户提供静态回退 URL：

openapi.yml

1 servers:
2   - url: https://api.{region}.{environment}.example.com/v1
3     x-fern-server-name: Default
4     x-fern-default-url: https://api.example.com/v1
5     variables:
6       region:
7         default: us-east-1
8         enum: [us-east-1, us-west-2, eu-west-1]
9       environment:
10         default: prod
11         enum: [prod, staging, dev]

1	class MyApiEnvironment:
2	REGIONAL_API_SERVER = {
3	"base": "https://api.example.com/v1",
4	"auth": "https://auth.example.com",
5	}

1	from my_api import MyApiClient
2
3	# 使用默认环境
4	# → https://api.example.com/v1
5	client = MyApiClient()
6
7	# 通过 URL 变量指定特定区域和环境
8	# → https://api.eu-west-1.staging.example.com/v1
9	client = MyApiClient(
10	region="eu-west-1",
11	environment="staging",
12	)
13
14	# 或者提供自定义基础 URL
15	# → https://api.us-west-2.staging.example.com/v1
16	client = MyApiClient(
17	base_url="https://api.us-west-2.staging.example.com/v1",
18	)

1	servers:
2	- url: https://api.{region}.{environment}.example.com/v1
3	x-fern-server-name: Default
4	x-fern-default-url: https://api.example.com/v1
5	variables:
6	region:
7	default: us-east-1
8	enum: [us-east-1, us-west-2, eu-west-1]
9	environment:
10	default: prod
11	enum: [prod, staging, dev]