引言

在数字化时代，数据的丰富性和复杂性使得API设计成为一项挑战。如何让API响应既丰富又易于管理？分页，作为第一步，已经为我们提供了基本的解决方案。但真正的用户友好性，往往需要在分页的基础上加入更多的智慧——排序和过滤。

为什么排序和过滤至关重要？

想象一下，当用户打开一个电商网站，他们通常希望看到的是最新的产品，而不是最古老的产品。同样，如果用户在搜索时只想看到特定时间段内的结果，那么简单的“按时间排序”和“按日期过滤”就显得尤为重要。

• 排序：用户不仅想知道哪些产品受欢迎，还想知道它们是如何排名的。例如，按销量、评分或最近更新的时间排序。
• 过滤：用户可能只想查看符合特定条件的产品，如价格低于某个阈值、品牌特定或颜色指定。

如何在Go API中实现排序和过滤？

让我们从基础的开始。

1. 接受排序参数

用户将通过URL传递排序参数。例如：

/items?page=1&limit=10&sort=created_at&order=desc

在这里，“created_at”是排序的列，“desc”是排序的方向。

2. 调整SQL查询

接下来，我们需要动态地调整SQL查询以包括排序。这通常涉及到字符串格式化和参数替换。

sort := r.URL.Query().Get("sort")
order := r.URL.Query().Get("order")

validSortColumns := map[string]bool{"name": true, "created_at": true}
if !validSortColumns[sort] {
    sort = "created_at"
}
if order != "asc" && order != "desc" {
    order = "asc"
}

query := fmt.Sprintf("SELECT id, name, created_at FROM items ORDER BY %s %s LIMIT %d OFFSET %d", sort, order, limit, offset)

3. 添加过滤功能

过滤功能同样重要。例如，用户可能只想看到在特定日期之后创建的产品：

/items?page=1&limit=10&name=Item&created_after=2025-01-10T20:38:57.832777

在这里，“name”是过滤列，“created_after”是过滤条件。

4. 调整SQL查询以包括过滤

我们需要在SQL查询中添加WHERE子句来处理这些过滤器。

query := fmt.Sprintf("SELECT id, name, created_at FROM items WHERE name LIKE '%s%' AND created_at > '%s' ORDER BY %s %s LIMIT %d OFFSET %d", name, createdAfter, sort, order, limit, offset)

测试增强型API

现在，让我们测试一下我们的增强型API：

• 按名称升序排列：/items?page=1&limit=10&sort=name&order=asc
• 过滤在特定日期之后创建的项目：/items?page=1&limit=10&name=Item&created_after=2025-01-10T20:38:57.832777
• 组合过滤器和排序：/items?page=1&limit=10&name=Item&created_after=2025-01-10T20:38:57.832777

结论

通过分页、排序和过滤，您的API现在更加用户友好和灵活。对于更高级的功能，请考虑添加基于游标的分页和分面过滤。

想要了解更多关于Go语言和API设计的知识吗？请关注我们的后续文章，并在Twitter和GitHub上与我们互动。