自定义 SDK 方法名称

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

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

1
paths:
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() 的方法：

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

多级嵌套

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

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

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