首页 > 解决方案 > 针对不同格式的一种资源的 Restful API 命名约定

问题描述

路径一:小复杂数据搜索

我有一个 UI,它依赖于 API 来提供/people/端点上人员的数据子集。API 限制为 100 人。此 API 允许排序和其他搜索功能(例如从其他集合中的人员集合中的外键获取信息)。

路线:/人/

第二条路径:简单的更大(1GB)数据导出

我想要第二条路径来调用一个单独的函数,该函数也为人们提供信息,但更多的字段和更多的行,10K 限制而不是 100。这是一个导出功能,适用于数据科学家也可以导入其他程序,例如擅长。数据将导出为扁平化的 json。这将不允许对其他集合进行排序或连接。

路线:???

我也不能将它命名为/people/,但似乎没有其他名词是正确的。像/people/export这样的动词是违反惯例的。

标签: api-design

解决方案


推荐阅读