Proximal 是一款前端开发者不可或缺的 NPM 包，它为开发人员提供了一个简单， 可靠的方式来在本地开发服务器和外部 API 之间进行代理。本文将为您提供一份详细的 Proximal 使用教程，来帮助您学习这个 NPM 包。
安装
要安装 Proximal，您首先需要安装 Node.js（如果您还没有安装的话）。安装完依赖项后，您可以在您的项目目录下运行以下命令来安装 Proximal：
npm install proximal
安装完成后，您需要创建一个配置文件，并且定义一些 API 的代理路由。在下一节中，我们将讨论如何正确配置这个文件。
配置
当 Proximal 被安装后，您需要在项目根目录下创建一个 proximal.config.js 文件。这个文件包含了您代理服务器的配置信息。
以下是一个例子：
module.exports = {
proxy: [
{
route: '/api',
url: 'https://example.com/api/'
}
]
}在上面的代码片段中，我们定义了一个 API 代理路由：/api。这个路由将被映射到我们在 url 参数中定义的外部 API 地址：https://example.com/api/。当我们在本地运行我们的服务器时，所有的 API 请求将会被代理到这个外部 API 地址上。
您可以根据您的需求，定义任意数量的 API 代理路由。
使用
一旦您已经完成了上面的配置，接下来您只需要在您的代码中添加以下一行来启动 Proximal 代理服务器：
const proximal = require('proximal');
proximal();启动服务器后，它会开始监听活动，同时也代理着您所定义的 API 路由。所有的 API 请求现在都将被正确地转发到您所定义的外部 API 地址上。
示例应用
在这个简单应用中，我们将把 proximal 用于与 GitHub API 交互。它将首先从 GitHub 上获取一个用户的信息，并显示在页面中。
首先，您需要在您的根目录下创建一个新的 proximal.config.js 文件，并添加以下代码：
module.exports = {
proxy: [
{
route: '/github',
url: 'https://api.github.com'
}
]
}接下来，您可以使用如下代码将 proximal 添加到您的应用中：
-- -------------------- ---- -------
----- -------- - --------------------
-----------
------------------------------
-------------- -- ----------------
---------- -- -
----- - ----- ---------- - - -----
----- ------ - -------------------------------------
----- -------- - ---------------------------------------
---------------- - -----
------------ - -----------
---这个代码可以从 GitHub API 中获得 octocat 用户的信息。接下来，它获取了用户的名字和头像，并将这两个数据分别添加到了页面的 #user-name 和 #user-avatar 元素中。
现在，您可以运行您的应用，并且能够在页面中看到用户的名字和头像了。
结论
在本文中，我们了解了 Proximal 代理服务器是如何帮助我们在本地开发中连接外部 API 的。我们首先学习了如何安装和配置 Proximal，然后我们学习了如何将它用于我们的示例应用中，并最终获得了一个简单的应用。我们希望这篇文章对您在前端开发中的工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600559e381e8991b448d77a1