是否有任何额外的粒度级别标准可以与 RESTful API 一起使用

Question

我正在开发一个 HR 产品，我们正在后端构建 RESTful API，以便将它们公开供我们的合作伙伴连接到该产品。 我们使用 REST 标准作为 API 的架构风格。

最近我们发现，一些过滤器参数与应有的不同。 例如：在我们的 api/employees 端点中，日期过滤器的实现方式不同。

1. Birth Day Filter 接受两个数组值，例如 from 和 to，它会返回出生日期在这两个日期之间的员工，包括 from date 和 to date。

过滤器[生日][从] = 2000-01-01 过滤器[生日][到] = 2001-01-01

2. Joined Date 过滤器有两个独立的过滤器，例如 joined_date_from 和 joined_date_to，其工作方式与上述过滤器类似。

过滤器[加入日期_起始日期] = 2000-01-01 过滤器[加入日期_起始日期] = 2001-01-01

这些类型的不匹配也存在于分页和排序选项中。

是否有任何地方定义了可被视为行业标准的 ReSTful API 的详细级别标准。

Answer 1

我推荐 Mark Masse 的“REST API 设计规则手册”。 它包含许多有用的信息以及解释和示例。