配置自动分页

以 Markdown 格式查看
企业功能

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

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

生成的 SDK 行为

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

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

设置自动分页

定义你的分页方案并指定结果的位置:

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

有关完整配置详细信息,请参阅 OpenAPI 中的分页