配置自动分页 | Fern Documentation

此功能仅适用于专业版和企业版计划。如需开始使用，请联系 support@buildwithfern.com。

Fern 的自动分页支持偏移量、游标、URI 和基于路径的分页方案，为 SDK 用户提供简单的迭代器来遍历所有结果，而无需手动管理分页复杂性。

生成的 SDK 行为

一旦为端点配置了分页，Fern 会生成一个返回 Page<T> 的 TypeScript SDK 方法，其中 T 是底层数据类型。Page<T> 实现了 AsyncIterable 接口，允许您的用户在 for await 循环中使用它。

1 const response = await client.users.list();
2 for await (const user of response) {
3   console.log(user);
4 }

定义您的分页方案并指定结果的位置：

1 ...
2 paths:
3   /plants:
4     x-fern-pagination:
5       offset: $request.page_number
6       results: $response.results
7 ...

有关完整配置详情，请参阅您的 API 定义格式的文档：

使用 x-fern-pagination 扩展注解端点并配置其他属性。

使用 pagination 字段注解端点并配置其他属性。