@abstractapi/javascript-exchange-rates 中文文档教程

Question

AbstractAPI javascript-exchange-rates library

通过几行代码将功能强大的来自摘要的汇率 API 集成到您的 Javascript 或 NodeJS 项目中。

汇率 API 是一个 REST API，它允许您：

• look up the latest exchange rates for 80+ currencies via the live endpoint
• get historical exchange rates using the historical endpoint
• convert an arbitrary amount from one currency to another using the convert endpoint

使用起来非常简单：您只需提交您的 API 密钥和货币符号（例如“USD”），API 将以当前汇率、历史汇率进行响应数据或转换率。

Documentation

Installation

您可以从我们的 CDN 通过 npm 安装 javascript-exchange-rates，或者将源代码下载到您的项目中。

ES6

从 npm 下载并安装库：

npm install @abstractapi/javascript-exchange-rates --save

在你的项目中，导入它并配置你的 API_KEY：

import {AbstractExchangeRates} from 'javascript-exchange-rates'

AbstractExchangeRates.configure('API_KEY')

Browser, from the CDN

你可以让浏览器通过 jsDeliver CDN 从最近的位置下载库：

<script src="https://cdn.jsdelivr.net/npm/@abstractapi/javascript-core@latest/dist/javascript-core.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@abstractapi/javascript-exchange-rates@latest/dist/javascript-exchange-rates.js"></script>
<script>
    AbstractExchangeRates.configure('API_KEY');

    // use the library
</script>

Browser, from the built file

你可以自己构建库，或者从 dist 目录获取已经构建的文件并加载它：

<script src="dist/javascript-exchange-rates.js"></script>
<script>
    AbstractExchangeRates.configure('API_KEY');

    // use the library
</script>

API key

从 抽象网站。

Quickstart

AbstractAPI javascript-exchange-rates 库返回一个 Promise< /a> 因此您可以使用以下方法之一：

Async/Await

async function getLiveRates(currency) {
  let response = await AbstractExchangeRates.live(currency);
  console.log(response);
}

async function getHistoricalRates(currency, date) {
  let response = await AbstractExchangeRates.historical(currency, date);
  console.log(response);
}

async function getConvertion(currency, target) {
  let response = await AbstractExchangeRates.convert(currency, target);
  console.log(response);
}

Using .then()

function getLiveRates(currency) {
  AbstractExchangeRates.live(currency)
    .then(response => {
      console.log(response);
    })
}

function getHistoricalRates(currency, date) {
  AbstractExchangeRates.historical(currency, date)
    .then(response => {
      console.log(response);
    })
}

function getConvertion(currency, target) {
  AbstractExchangeRates.convert(currency, target)
    .then(response => {
      console.log(response);
    })
}

API response

API 响应包含以下字段：

live response parameters

| 参数| 类型| 详情 | | - | - | - | | 基地 | 字符串 | 用于获取汇率的基础货币。 | | 上次更新 | 字符串 | 上次更新返回数据时的 Unix 时间戳。 | | 汇率 | 对象 | 一个 JSON 对象，其中包含每个目标货币作为键，其对基础货币的汇率作为该键的值。 |

historical response parameters

| 参数 | 类型 | 详情 | | - | - | - | | 基地 | 字符串 | 用于获取汇率的基础货币。 | | 日期 | 字符串 | 根据成功的请求提取货币的日期。 | | 汇率 | 对象 | 一个 JSON 对象，其中包含每个目标货币作为键，其对基础货币的汇率作为该键的值。 |

convert response parameters

| 参数 | 类型 | 详情 | | - | - | - | | 基地 | 字符串 | 用于获取汇率的基础货币。 | | 目标 | 字符串 | 基础金额转换成的目标货币。 | | 日期 | 字符串 | 根据成功的请求提取货币的日期。 | | 基数 | 浮动 | 请求中的基础货币金额。 | | 转换数量 | 浮动 | base金额已转换为目标货币的金额 | | 汇率 | 浮动 | 用于将基础金额从基础货币转换为目标货币的汇率 |

Detailed documentation

您可以在 Abstract 帮助页面 中找到更多信息和请求示例。

Getting help

如果您在安装或使用该库时需要帮助，请联系 Abstract 的支持。

有关错误报告和功能建议，请使用此存储库问题页面。

Contribution

贡献总是受欢迎的，因为它们提高了我们提供给社区的图书馆的质量。

请提供适当单元测试涵盖的更改，并将它们发布到拉取请求页面。

NPM

Installation

在命令行中运行 npm install 以安装依赖项。 要更新这些依赖项，您需要运行 npm update。

Building

要构建库并在 dist 目录中生成缩小文件，您需要运行 npm run build。

要构建库，您需要运行 npm run build:lib。

Test

要运行测试套件，您需要来自抽象网站的 API 密钥，您可以运行：

EXCHANGE_RATES_API_KEY=(your key here) npm run test