如何最好地设计具有多个过滤器的 REST API?

2023-12-21

作为一个个人编程项目,我正在抓取我大学的课程目录并以 REST API 的形式提供数据。我已成功抓取所有数据并将其存储在数据库中,现在正在开发 API。

课程可以根据许多标准进行过滤:教师、学院、学分、时间、日期等。

在这种情况下提供 API 的最佳方式是什么?

Option 1

提供大量 URL,例如

example.com/api/byinstructor/<instructorcode>
example.come/api/bycollege/<collegecode>
example.com/api/bycollegeandinstructor/<collegecode>/<instructorcode>
...and so on

我需要有一个所有排列的 URL。对于我和 API 消费者来说,这似乎非常麻烦,而且非常不干燥。

Option 2

只提供主要选项的 API,例如:

example.com/api/byinstructor/<instructorcode>
example.come/api/bycollege/<collegecode>

如果消费者想要bycollegeandinstructor,他自己进行过滤。

Option 3

用户将 JSON 字符串传递给我,我用它来获取过滤条件

example.com/api/getcourses/<jsonstring>

jsonstring = 
{ 
  instructor:<instructorcode>,
  college:<collegecode>,
  ...and so on
}

我想除了 Json 字符串之外,我还可以需要一个 POST 数组,但这对于消费者来说似乎不直观,因为他正在获取数据。

或者还有另一种我不知道的方法吗?如果第三个选项是最佳选项,您能否提供一个简短的摘要,以便根据可能具有可变数量值的 JSOn 字符串准备 SQL 查询?


为了扩展 I.F. 的答案,听起来您有一个资源,即一组课程,它位于 URI 处:

/courses

过滤该资源通常是使用查询参数来过滤该单个资源来完成的,例如:

/courses?college=123&instructor=321

通过这样做,您可以避免所有可能的排列造成资源激增的问题。

从根本上来说:只有一种资源,可以根据需要进行过滤。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何最好地设计具有多个过滤器的 REST API? 的相关文章

随机推荐

  • 如何测试存储库中标记为@Modifying的方法?

    例如我有 public interface CrudUserRepository extends JpaRepository
  • 使用 Active Directory 集成身份验证向 Azure Sql 数据库添加具有特定权限的新用户

    我有一个带有两个数据库的 Azure SQL Server 我尝试对其使用 Azure Active Directory 集成身份验证 其中一个数据库至关重要 大多数用户只需要被授予对此数据库的 读 访问权限 要添加具有 读者角色 的新用户
  • WCF 客户端错误:“未指定安全令牌颁发者的地址”

    我从 WCF 客户端收到以下错误 未指定安全令牌颁发者的地址 必须在目标 http site com TLAPI svc 的绑定中指定显式颁发者地址 或者必须在凭据中配置本地颁发者地址 我正在尝试连接到 SharePoint 服务应用程序
  • std::string::find 在 C++ 中未按预期工作

    我试图验证输入字符串中是否存在特定字符串 如果是 则根据找到的字符串执行某些操作 但似乎无论如何它总是在做第一个任务 if inputString find str1 gt 0 do something else if inputStrin
  • g++ 实现如何处理这种情况?

    这是一个后续问题this one https stackoverflow com questions 10002082 typecasting with virtual functions 考虑这个例子 include
  • Google 登录,数据库端

    我读过有关使用 Google 处理登录的信息这个网站 https developers google com accounts docs OAuth2Login 但它并没有很好地解释数据库应该发生什么 通常 对于数据库中的用户帐户 您会有类
  • 为什么我不能将变量传递到 PHP 中的包含文件中?

    我以前也遇到过这个问题before https stackoverflow com questions 1601348 passing php variables to an included file没有真正的解决方案 又出现这种情况了
  • 需要时自动加载函数/类库

    首先 介绍一下背景 我工作的公司使用massive函数 类库 它包含在每个页面上 成千上万行函数 其中 90 甚至可能不会在页面上调用 为了稍微减轻服务器负载 我一直在尝试更智能的库设置 为此 我将整个文件分成分类库文件 即 sql fun
  • rate() 函数如何平均请求持续时间?

    引自 普罗米修斯 观察值的计数和总和 https prometheus io docs practices histograms count and sum of observations doc 要根据名为 http request du
  • 浮动 div css 下的 margin-top

    我在 float right div 下有一个 div 由于某种原因 上边距无法应用于第一个 div 这是CSS over width 80 float right color e68200 under clear both backgro
  • WPF 中的数据模板

    我有一个关于 WPF 中的数据模板的一般性问题 假设我有一个名为 Question 的抽象类 以及各种子类 例如 MathQuestion GeographyQuestion 等 在某些情况下 使用 Question 数据模板将问题呈现为
  • 从作为引擎安装的 gem 重载 lib 文件

    我正在使用作为引擎安装的 gem 并想要自定义一些类 我想要重载的文件位于我的本地 rvm 目录中 rvmdir gem lib modulename containers file to override rb 我将文件复制到我的应用程序
  • 如何保证时间戳始终是唯一的?

    我使用时间戳对程序中的并发更改进行临时排序 并要求更改的每个时间戳都是唯一的 但是 我发现只需调用DateTime Now是不够的 因为如果快速连续调用它通常会返回相同的值 我有一些想法 但我认为没有什么是 最佳 解决方案 我是否可以编写一
  • MSBuild:包含自定义资源文件作为嵌入资源

    我在构建时使用 MSBuild 动态生成资源文件 但为了能够在运行时读取该资源文件 我需要它成为嵌入式资源 我到处都在研究如何在 a 中标记文件 csproj作为嵌入式资源 我什至尝试过这一点 但没有成功
  • json.net 特殊字符转义

    对 JSON 有点陌生 所以请原谅这个简单的问题 但根据找到的特殊字符列表here http www w3schools com js js special characters asp and here https developer m
  • Qt-fy 现有枚举与 Qt 元数据一起使用

    假设我有一个现有的enum X A B 并希望将其与 Qt 元数据一起使用 例如QMetaObject QMetaEnum QMetaObject meta FsxSimConnectQtfier staticMetaObject for
  • 高可靠性/可用性/安全性编码 - 我应该阅读哪些标准?

    我听说汽车行业有一个叫做 MISRA C 的东西 其他高可靠性 可用性 安全行业的相关标准是什么 比如 Space Aircraft 银行 金融 汽车 Medical 国防 军事 Adam 参观戈达德太空飞行中心及其编码标准 http so
  • 使用“mysql_fetch_row”从数据库检索结果并使用 PHP 和 mysqli 插入数组?

    我需要从几行检索数据 然后将结果插入到枚举数组中 这样我就可以使用 for 循环来回显它 我有这个 我已经连接到数据库 genres sql SELECT genreID FROM genres WHERE imdbID if stmt g
  • 如何基于Web服务更改android中的语言

    目前 我正在开发我正在使用的 Android 项目English作为主要语言 我在用着strings xml字符串常量文件 现在 我想根据网络服务动态更改语言 该服务将根据用户选择 在 设置 中 创建 我知道我们必须为每种语言创建单独的 s
  • 如何最好地设计具有多个过滤器的 REST API?

    作为一个个人编程项目 我正在抓取我大学的课程目录并以 REST API 的形式提供数据 我已成功抓取所有数据并将其存储在数据库中 现在正在开发 API 课程可以根据许多标准进行过滤 教师 学院 学分 时间 日期等 在这种情况下提供 API