OpenAPI扩展

自定义 SDK 方法名称

以 Markdown 格式查看

使用 x-fern-sdk-group-name 和 x-fern-sdk-method-name 扩展来控制端点在您的 SDK 和 CLI 中的组织方式。

Fern 会自动解析 operationId

如果没有扩展存在，Fern 使用您的 operation ID 来生成 SDK 方法名称。将 operation ID 格式化为 {tag_name}_{operation_name}（例如：users_get）以自动生成类似 users.get() 的方法。如果 operation ID 不以 tag 开头，Fern 会直接将其用作方法名称。

在下面的示例中，Fern 将为 POST /users 端点生成一个名为 client.users.create() 的方法。

openapi.yaml
1paths:
2  /users:
3    post:
4      x-fern-sdk-group-name: users
5      x-fern-sdk-method-name: create

顶级方法

如果您省略 x-fern-sdk-group-name 扩展，生成的 SDK 方法将位于客户端的根目录，而不是嵌套在资源组下。在下面的示例中，Fern 将生成一个名为 client.send() 的方法：

openapi.yaml
1paths:
2  /send:
3    post:
4      x-fern-sdk-method-name: send

多级嵌套

查看 merge.dev 如何使用嵌套组的示例这里。

如果您添加多个 x-fern-sdk-group-name 扩展，那么生成的 SDK 将嵌套组名称。生成的 SDK 方法保留组名称的顺序。

在下面的示例中，Fern 将生成一个名为 client.users.notifications.send() 的方法：

openapi.yaml
1paths:
2  /users/notifications:
3    post:
4      x-fern-sdk-group-name:
5        - users
6        - notifications
7      x-fern-sdk-method-name: send