【问题标题】:Public API Architecture公共 API 架构
【发布时间】:2019-05-20 07:55:28
【问题描述】:

我一直致力于数据透明度项目,其中一项举措是使用 API 提供对我们数据的访问权限。到目前为止,我们已经决定使用 API Manager 平台来公开和管理所有 API。 API 网关(由平台提供)将控制所有请求。

我们现在的主要疑问是,应该如何构建公共 API?它的架构应该如何规划?例如(非常简化的例子):

(1)复制生产数据库:

(2)不复制生产数据库:

在情况(1)(复制)中,我该如何处理实时数据?例如:巴士位置?

在情况 (2) 中,我可能有什么顾虑? (性能、安全性...)

我一直在尝试寻找著名的公共 API 案例(如 twitter API),但我还没有找到任何关于公共 API 架构和实现的信息。

【问题讨论】:

    标签: rest api architecture gateway api-gateway


    【解决方案1】:

    我认为应该先建立几个条件。

    1。您的产品不(不应该)与您的 API 分开。

    大多数公司都在以一种或另一种方式使用外部 API。他们为什么不呢?它是可靠的/被监控的/分布式的/负载平衡的,所以它会是一个很好的服务。他们可能有这些 API 的一些内部版本用于测试/发布环目的,但主要是它们的前端将构建在您可以调用的同一堆栈上。因此,您不应将 API 与您在生产中拥有的东西完全分开。在当今时代,它实际上只是系统的一部分。

    2。数据库复制

    这两个图表在我看来都不正确。顶部看起来不正确,因为您正在从另一个实例显式读取,底部看起来不正确,因为您没有复制。现在复制是一个非常冗长的主题 - 简短的课程是您绝对应该进行复制。查看此链接以查看复制数据的不同类型的一致性:https://en.wikipedia.org/wiki/Consistency_model 您必须在此处进行一些权衡,但作为示例取决于您的负载和负载模式;你可以复制你的数据库,允许你的读取是多区域的,写入是单区域的,你的业务层——这也为你的 API 部署到多个区域提供了动力。 (就是如果你有足够的流量)

    3。设计问题

    这有一些设计问题,但让我们先解决您的问题。

    在情况(1)(复制)中,我该如何处理实时数据?例如:巴士位置?

    • 查看不同的一致性类型,然后选择最适合您的服务的一种。
    • 您理想的实时体验是什么?这是一个地图应用程序,您将公交车位置的通知推送到设备/或者您是否希望用户连接并查询以查看下一班公交车的时间?根据您的需要,您可能会有不同的设计决策。 (我也非常怀疑您的总线位置是否来自数据库)尽管它们都不会真正影响复制,但一致性 + 读/写比率和整体负载/负载模式在本案。

    在情况 (2) 中,我可能有什么顾虑? (性能、安全性...)

    您不应该使用案例 2。

    我认为您应该首先确定用户和系统的要求。仅通过这些图表进行设计也非常困难,因为我们无法真正知道我们是为本地区域还是为全球系统设计这个系统。理想情况下,您将对所有内容进行冗余处理(因此,多个服务器为网络流量提供服务/多个数据库/多个 CDN 用于您的静态内容等),因此您将获得更高的服务质量和更小的跌倒机会。有时,甚至整个云服务区域都会因自然灾害而停机/因此跨不同区域进行复制是一个好主意,但您的系统可能并不真正需要它。在所有情况下,您的公共 API 都不应与您的生产分开。

    【讨论】:

    • 感谢您的回答,抱歉回复晚了,对您有很大帮助。抱歉,我对复制部分的解释有误(可能我简化得太多了),但重点是公共 API 应该使用生产数据库。
    • 是的。如果你有一个网络应用或移动应用,你会以一种使用公共 API 的方式构建,所以你总是知道在前端之前的所有层都是相同的。
    猜你喜欢
    • 1970-01-01
    • 2019-06-20
    • 1970-01-01
    • 2020-01-17
    • 2011-11-20
    • 2020-09-22
    • 1970-01-01
    • 2020-11-24
    相关资源
    最近更新 更多