php - API (REST) 过滤表名、复杂查询

Question

我正在创建用于(目前)从移动客户端 Android 和 iOS 使用的 API。主要应用是一种电子商店。

我有 news 端点，让我们考虑例如主要 url 是 http://consumer.com/api/v0/

目前我有这样的端点来过滤新闻 /news?actual=1&moderation=1 ....

GET 参数的简单数组，但我对此有一些疑问。坏处(我认为如此)是过滤器参数(actual,moderation)与数据库中的列名相同。

1. 公开真实的列名是不是个坏主意？
2. 我该如何解决这个问题？我有一个想法是引入一些中间件(无论如何这是可能的，但我使用 lumen 的可能性很大)将一些假名翻译成例如 filter_actual 和 filter_mooderation真实的表名，现在这不会阻止我的应用程序，只需再添加一层(中间件的功能)。或者还有另一种方法可以做到这一点。

但主要问题是，如果我需要执行复杂查询，请考虑下一个示例。

news 表有 company_id 列，company 表有 blocked 列，该列描述公司是否被封锁或不。

我需要获取未被屏蔽的公司的所有新闻，我已经执行了类似这样的伪查询 SELECT * FROM news WHERE company_id IN (SELECT id FROM companies WHERE blocked=0) ( I还没有检查过，但我希望你有一个想法)

如何为这种类型的查询制作端点过滤器，现在我已经引入了额外的选项，例如 non_blocked_companies，然后与其他过滤器一起传递 /news?actual=1&moderation=1&non_blocked_companies=1 然后检查此参数是否与其他参数一起传递，因此在代码中它很快就会看起来像很多 if 语句，具体针对每个复杂查询。

我想过这样的查询 /news?actual=1&moderation=1&blocked[companies:company_id]=0 我认为很清楚。我使用其他表 (companies) 中的字段 news 表 (company_id) 中存储公司 ID 的列。

但首先对我来说它看起来很难看，因为它在 get 请求中是相当复杂的查询，但对我来说主要不好的一面是我需要确切地知道表名，表列，现在这不是问题，因为此API仅用于移动客户端通信，不会公开，但无论如何我想做可靠的API

1. 如我之前所述，这是个坏主意吗？
2. 我如何灵活地组织我的 API(API 的变化应该尽可能少地影响前端)

请更高级的 API 开发人员提出对我来说最好的选择。

谢谢。

Answer 1

Is it bad idea to expose real column names ?

是个不错的主意。开发人员了解到底发生了什么是有好处的。我会给出专有名称而不是直接的列名。亚马逊和谷歌有很多 API 都在做同样的事情。

How can I solve the problem ? I have one idea is to introduce some middleware (it is possible anyway, but I am using lumen it great possibility) that will translate some fake names for example filter_actual and filter_mooderation into real table names, this will not brake my app now,just add one more layer (power of middlewares). Or there is another way to do this.

很多时候开发人员不喜欢在获取响应中发送正文，但如果您觉得它会更复杂并且会破坏应用程序。我建议这样做。调用电话之前，这里有详细的讨论HTTP GET with request body

您可以添加许多验证以使 API 更强大并处理不同的请求场景。