全局配置 | Fern Documentation

api.yml 配置支持全局配置，如请求头和路径参数。

全局请求头

您可以指定要包含在每个请求中的请求头：

api.yml

1 name: api
2 headers:
3   X-App-Id: string

在 api.yml 中定义全局请求头时，您必须在端点示例中包含它们。

全局路径参数

您可以指定要包含在每个请求中的路径参数：

api.yml

1 name: api
2 base-path: /{userId}/{orgId}
3 path-parameters:
4   userId: string
5   orgId: string

覆盖基础路径

如果您有某些端点不在配置的 base-path 下，您可以在端点级别覆盖 base-path。

imdb.yml

1 service: 
2   endpoints: 
3     getMovie: 
4       method: POST
5       base-path: "override/{arg}"
6       path: "movies/{movieId}"
7       path-parameters: 
8         arg: string

全局查询参数

目前还不能指定要包含在每个请求中的查询参数。如果您希望看到这个功能，请为此问题投票。

幂等性请求头

配置幂等性请求头来定义 SDK 用户可以为安全请求重试指定的请求头。您还必须将每个端点标记为幂等才能公开这些请求头。当两者都配置时，Fern 生成的 SDK 会将这些请求头作为幂等端点调用的参数公开。

api.yml

1 name: api
2 auth: bearer
3 idempotency-headers:
4   Idempotency-Key: string
5   Idempotency-Expiration: optional<integer>

idempotency-headers 中的每个键是 HTTP 请求头名称，值是类型。然后 SDK 用户可以在调用幂等端点时指定这些请求头。