分页

paths:
  /plants:
    get:
      operationId: list_plants
      x-fern-pagination:
        offset: $request.page_number
        results: $response.results
      parameters:
        - name: page_number
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: List of plants
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Plant'

配置选项

x-fern-pagination 扩展支持以下属性：

Property	Description
`offset`	Path to the offset parameter in the request (e.g., `$request.page`)
`cursor`	Path to the cursor parameter in the request (e.g., `$request.cursor`)
`next_cursor`	Path to the next cursor value in the response (required for cursor pagination)
`next_uri`	Path to the next page’s URL in the response (e.g., `$response.next_page_url`)
`next_path`	Path to the relative path for the next page in the response (e.g., `$response.next_page_path`)
`results`	Path to the results array in the response (e.g., `$response.data`)
`step`	Path to the page size parameter, ensures offset increments correctly
`has-next-page`	Path to a boolean indicator for additional pages

查找 `results` 的位置

如果结果嵌套在响应对象中，请使用点访问记法指定路径。例如，如果结果位于 my_nested_object.inner_list 中，则 results 路径为 $response.my_nested_object.inner_list。

1 MyResponseObject:
2   type: object
3   properties:
4     my_nested_object:
5       type: object
6       properties:
7         inner_list:
8           type: array
9           items:
10             $ref: '#/components/schemas/Plant'

paths:
  /plants:
    get:
      operationId: list_plants
      x-fern-pagination:
        offset: $request.page_number
        results: $response.results
      parameters:
        - name: page_number
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: List of plants
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Plant'

配置选项

x-fern-pagination 扩展支持以下属性：

Property	Description
`offset`	Path to the offset parameter in the request (e.g., `$request.page`)
`cursor`	Path to the cursor parameter in the request (e.g., `$request.cursor`)
`next_cursor`	Path to the next cursor value in the response (required for cursor pagination)
`next_uri`	Path to the next page’s URL in the response (e.g., `$response.next_page_url`)
`next_path`	Path to the relative path for the next page in the response (e.g., `$response.next_page_path`)
`results`	Path to the results array in the response (e.g., `$response.data`)
`step`	Path to the page size parameter, ensures offset increments correctly
`has-next-page`	Path to a boolean indicator for additional pages

查找 `results` 的位置

1 MyResponseObject:
2   type: object
3   properties:
4     my_nested_object:
5       type: object
6       properties:
7         inner_list:
8           type: array
9           items:
10             $ref: '#/components/schemas/Plant'

分页

分页

企业功能

配置选项

查找 `results` 的位置

企业功能

配置选项

查找 `results` 的位置

1	paths:
2	/plants:
3	get:
4	operationId: list_plants
5	x-fern-pagination:
6	offset: $request.page_number
7	results: $response.results
8	parameters:
9	- name: page_number
10	in: query
11	schema:
12	type: integer
13	responses:
14	'200':
15	description: List of plants
16	content:
17	application/json:
18	schema:
19	type: object
20	properties:
21	results:
22	type: array
23	items:
24	$ref: '#/components/schemas/Plant'

1	MyResponseObject:
2	type: object
3	properties:
4	my_nested_object:
5	type: object
6	properties:
7	inner_list:
8	type: array
9	items:
10	$ref: '#/components/schemas/Plant'

企业功能

配置选项

查找 results 的位置

企业功能

配置选项

查找 results 的位置

查找 `results` 的位置

查找 `results` 的位置