如何使用will_paginate为API端点列表实现分页？是否仅用该gem可行？

嘿，这个问题我熟！是的，will_paginate确实能帮你实现这个列表的分页，不过因为你用了JSON:API适配器，得稍微做些适配才能让响应符合规范。下面一步步来：

步骤1：安装并配置will_paginate #

首先在你的Gemfile里添加这个gem：

gem 'will_paginate'

然后运行bundle install完成安装。

步骤2：修改控制器查询并添加分页元数据 #

接下来，你需要把原来的@business查询改成支持分页的形式，同时在JSON响应里加入分页相关的元数据（这是JSON:API规范推荐的做法）。修改你的index方法：

def index
  # 从请求参数里获取页码和每页数量，per_page默认设为20可按需调整
  @business = Business.paginate(
    page: params[:page], 
    per_page: params[:per_page] || 20
  )
  
  # 渲染时带上分页元数据，让前端能拿到分页关键信息
  render json: @business, 
         adapter: :json_api,
         meta: {
           current_page: @business.current_page,
           next_page: @business.next_page,
           prev_page: @business.previous_page,
           total_pages: @business.total_pages,
           total_count: @business.total_entries
         }
end

这样前端请求时，只需要带上page（比如?page=2）和可选的per_page参数，就能拿到对应页的数据，响应里的meta字段会包含所有分页相关的统计信息。

进阶：添加JSON:API规范的分页链接 #

如果你想完全贴合JSON:API的分页建议，可以在响应里加入links字段，包含首页、上一页、下一页、末页的链接。修改后的代码如下：

def index
  @business = Business.paginate(
    page: params[:page], 
    per_page: params[:per_page] || 20
  )
  
  # 构建分页链接，用compact去掉nil值（比如第一页没有prev链接）
  pagination_links = {
    first: businesses_url(page: 1, per_page: @business.per_page),
    prev: @business.previous_page ? businesses_url(page: @business.previous_page, per_page: @business.per_page) : nil,
    next: @business.next_page ? businesses_url(page: @business.next_page, per_page: @business.per_page) : nil,
    last: businesses_url(page: @business.total_pages, per_page: @business.per_page)
  }.compact

  render json: @business, 
         adapter: :json_api,
         meta: { 
           total_count: @business.total_entries, 
           total_pages: @business.total_pages 
         },
         links: pagination_links
end

几个注意点 #

• 如果你有其他查询条件（比如where筛选），要把paginate放在链式调用的最后，比如Business.where(active: true).paginate(...)
• 确保前端可以传递page和per_page参数来控制分页行为
• 最新版本的will_paginate兼容大部分Rails版本，包括API模式的项目

内容的提问来源于stack exchange，提问作者L11