RESTful API 的整合 —— 如何将 API 整合在一起

前言

在现代 Web 应用程序的设计和开发中, RESTful API 是不可避免的一部分。RESTful API 可以使得前端和后端分离,从而实现对系统的松散耦合,提高了系统的拓展性和可维护性。然而,在实际应用过程中,有时会存在各类第三方 API 和自有 API 的搭配使用。本文将介绍如何将多个 API 整合起来,实现两个 API 的交互及穿透调用。况且,本文不仅仅是围绕开发者阅读的一本入门手册,我们还将提供详尽的例子和最佳实践,助你顺利完成 RESTful API 的整合。

RESTful API 简介

RESTful API 是基于 HTTP 协议的 API,其建立在客户端和服务器之间传输数据的协议上。在 RESTful API 中,对资源的操作,对应着对 URL 上资源 ID 操作的 CRUD 操作。比如对于文章资源,其请求方式和指令如下:

  • 获取文章列表:GET /articles
  • 获取单篇文章:GET /articles/:id
  • 创建新文章:POST /articles
  • 编辑文章:PUT /articles/:id
  • 删除文章:DELETE /articles/:id

在 RESTful API 中,再也不用每个 API 都单独组织 URL,避免了 URL 重叠的困扰。同时,RESTful API 不仅仅是简化了我们的请求方式,它更是整合了多个服务之间的请求与响应接口。

在实际开发中,经常会出现多个 API 的通过调用实现功能需求,而多个 API 的整合是无法避免的。这里我们讨论两个部分的整合:API 的交互;API 的穿透调用。

API 之间的交互

API 之间的交互,在实际过程中分为同步和异步两种方式。异步方式一般通过消息队列等方式,而如此做往往较为繁琐,常常会出现 API 不一致,难以维护的情况。同步方式则是一种较为理想的API交互方式。

实际操作

我们通过两个题材性质截然不同的 API 为例讲解其如何描述 API 之间的交互逻辑,SPAM 识别 API 和资讯推荐 API 的设计思路。下面,我们以 JSON 格式举例说明。

SPAM 识别 API(以调用健康咨询回答的接口为例)

-
    ------- -
        ----- ------
        ------------- ------
        -------- ---
        --------- ------
    -
-
  • id: 评论 ID
  • article_id:文章 ID
  • score:SPAM 识别的分数
  • status:SPAM 状态,值为 okspam

资讯推荐 API(以使用学科分类进行推荐的接口为例)

-
    ------- -
        -
            ----- --
            -------- -------
            ----------- ----------
            -------- ---------------
        --
        -
            ----- --
            -------- -------
            ----------- -----------
            -------- ---------------
        --
        -
            ----- --
            -------- -------
            ----------- -------
            -------- ---------------
        -
    -
-
  • id:资讯 ID
  • title:资讯标题
  • category:资讯学科分类
  • image:资讯图片链接

为了更好地整合这两个 API,我们需要先对它们进行分类和拓扑映射。具体可以使用数据跟踪或者图结构等方式,将需要的数据进行结构化支持。

以在一篇文章下面插入资讯推荐为例,调用 SPAM 识别 API 过滤 SPAM 后,再使用资讯推荐 API 查询文章的学科分类,选择相应类别的资讯提供给用户。

另外,为了在 restful 接口中实现多个 API 的交互,一种比较好的方式是使用分布式事务,确保在需要加事务的地方一定保证其一致性。

API 的穿透调用

API 的穿透调用是一种在后端中实现 API 的调用,具有降低前端压力的特点。在用户的请求中,对前端的影响相对较小,这也是为什么它如此流行的原因。

实际操作

我们使用 axios 作为后端 API 框架,为数据的请求和响应提供支持,使得对 API 的穿透调用能够实现。

在实际过程中,我们使用 axios 在服务的中间层中进行穿透调用。通过以下方式,将所有需要调用的接口参数和参数值直接放到配置文件中,请求和响应数据的处理都交给了 axios 这个工具来实现。这个过程比较简单,只需要做以下几个步骤:

  • 安装 axios: npm install --save axios
  • 创建一个 axios 的实例
  • 发送请求
-- -- ----- --
----- ------- - --------------
    -------- ----------------------
    -------- ----
---

-- ----
---------
    ---- --------------------------
    ------- ------
    ------- -
        --- --
        -------- -----
    -
----------- -- -
    ----------------------
------------ -- -
    -----------------
---

在上述代码中,我们通过 axios 创建了一个实例 request,设定了基础 URL 地址和超时时间(每个 API 都是不同的,需要设置不同的基础 URL);然后,我们发送了一个 GET 请求,它调用了接口 comments 并附带上参数 articleId,它还传了参数 idcontent。请求完成后,我们将得到一个 Promise 实例,它含有响应结果,我们可以直接使用 res.data

为了让穿透调用充分发挥作用,在前端调试 API 的时候,可以先对 API 进行实现好的封装,这样在进行调试的时候更简单方便。以 SPAM 检测、资讯推荐 2 个 API 为例,我们定义了如下的 API 封装类:

-- ------
------ ------- ---- -----------

----- --- - --

------------- - ----- ------- -- -
    --- -
        ----- ------ - -
            ---- -------------
            ------- -------
            ----- -
                --------
            --
        -
        ----- ------ - ----- ---------------

        -- ------------------- --- ----- -
            ------ ----
        -
        -- ------------------- --- ------- -
            ------ -----
        -

        ------ ----
    - ----- --- -
        ----------------
        ------ -----
    -
-

----------------- - ----- --------- -- -
    --- -
        ----- ------ - -
            ---- --------
            ------- ------
            ------- -
                ----------
            --
        -
        ----- ------ - ----- ---------------
        ------ ----------------
    - ----- --- -
        ----------------
        ------ --
    -
-

------ ------- ---

我们在 API 的封装类中定义了 checkSpam 和 recommendNews 函数分别用来检验评论是否是 SPAM,以及获取推荐的资讯。在这个 API 封装类中,我们需要导入前面我们创建的 axios 实例,然后在 checkSpam 和 recommendNews 中使用 axios 发送请求。对于请求的参数,我们放在了一个配置对象 config 中,并根据 API 接口的不同,配置了不同的请求方式和参数。

总结

本文主题围绕 RESTful API 的整合,分析了 API 之间交互和穿透调用和如何实现。让我们更好地理解 RESTful API 的工作原理和交互过程,并且掌握如何在具体场景中运用 RESTful API 实现数据通信。同时,本文还分享了实用的技巧和案例,帮助读者更好地掌握 RESTful API 的整合。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6545b3157d4982a6ebf50d03


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    1 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    1 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    1 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    1 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    1 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    1 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    1 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    1 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    1 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    1 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    1 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    1 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    1 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    1 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    1 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    1 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    1 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    1 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    1 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    1 个月前

相关推荐

    暂无文章