npm 包 terrabrasilis-api-fork 使用教程-JavaScript中文网-JavaScript教程资源分享门户

概述

terrabrasilis-api-fork 是一个 Node.js 模块，该模块提供了一组简单的 API，用于获取巴西国家森林监测数据。本文将为您提供该模块的使用教程，详细介绍该模块的使用方法和功能特点。

安装和部署

使用 terrabrasilis-api-fork 需要在 Node.js 环境中安装该模块。首先，您需要使用 npm 包管理器来安装 terrabrasilis-api-fork，如下所示：

npm install terrabrasilis-api-fork --save

安装完成后，可以在 Node.js 代码中引入该模块：

const TerrabrasilisApi = require('terrabrasilis-api-fork');

使用方法

创建 TerrabrasilisApi 实例

创建 TerrabrasilisApi 实例之前，需要获取 API 接口的 URL，并根据情况设置代理地址。TerrabrasilisApi 构造函数的参数如下：

endpointUrl：API 接口的 URL
useProxy：是否使用代理
proxyUrl：代理地址（当 useProxy 为 true 时必需）

以下是创建 TerrabrasilisApi 实例的示例代码：

const TerrabrasilisApi = require('terrabrasilis-api-fork');

const endpointUrl = 'https://terrabrasilis.dpi.inpe.br/api/v1';
const useProxy = true;
const proxyUrl = 'http://myproxy.org:8080';

const api = new TerrabrasilisApi(endpointUrl, useProxy, proxyUrl);

获取数据列表

创建 TerrabrasilisApi 实例后，您可以调用 getDataList 来获取数据列表。getDataList 方法的参数如下：

dataset：数据集名称，例如 "PRODES_DETER_AMZ"、"PRODES_CERRADO"、"DETER_BIM_AMZ"、"DETER_BIM_CERRADO"
startDate：起始日期，格式为 "YYYY-MM-DD"，例如 "2020-05-01"
endDate：结束日期，格式为 "YYYY-MM-DD"。如果未指定，将返回最新数据
page：要获取的页数。如果未指定，将返回所有数据
perPage：每页返回的数据量。如果未指定，将返回所有数据

以下是获取数据列表的示例代码：

const dataset = 'PRODES_DETER_AMZ';
const startDate = '2020-01-01';
const endDate = '2020-12-31';
const page = 1;
const perPage = 50;

api.getDataList(dataset, startDate, endDate, page, perPage).then((dataList) => {
    console.log(dataList);
}).catch((err) => {
    console.error(err);
});

以上代码将返回一个 Promise 对象，Promise 对象的 resolve 回调函数将接收到一个如下所示的数据列表：

[
    {
        "id": "k34xn4b4o17l",
        "archiveName": "PRODES_2019_2020_amz.zip",
        "md5": "617387e34c5104224f4d4fa2474ffe4c",
        "date": "2020-10-25",
        "size": "95729641"
    },
    {
        "id": "kb2vba28zgyb",
        "archiveName": "PRODES_2018_2019_amz.zip",
        "md5": "6c7f6db27414cee9ac8bd982f1bed69c",
        "date": "2019-11-29",
        "size": "53962206"
    },
    ...
]

下载数据文件

您可以调用 downloadDataFile 方法下载数据文件，该方法的参数如下：

dataset：数据集名称
id：数据列表的 ID
outputPath：下载文件的保存路径

以下是下载数据的示例代码：

const dataset = 'PRODES_DETER_AMZ';
const id = 'k34xn4b4o17l';
const outputPath = '/path/to/my/downloaded/PRODES_2019_2020_amz.zip';

api.downloadDataFile(dataset, id, outputPath).then(() => {
    console.log(`Downloaded ${dataset} ${id} to ${outputPath}`);
}).catch((err) => {
    console.error(err);
});

获取数据文件下载链接

如果您希望直接使用浏览器下载数据文件，可以调用 getDataFileDownloadUrl 获取数据文件的下载链接，该方法的参数与 downloadDataFile 方法的参数一致。

以下是获取数据文件下载链接的示例代码：

const dataset = 'PRODES_DETER_AMZ';
const id = 'k34xn4b4o17l';

const url = api.getDataFileDownloadUrl(dataset, id);
console.log(url);  // https://terrabrasilis.dpi.inpe.br/api/v1/download/PRODES_DETER_AMZ/k34xn4b4o17l

综述

本文提供了使用 terrabrasilis-api-fork 的详细教程，包括了如何创建 TerrabrasilisApi 实例、如何获取数据列表、如何下载数据文件以及如何获取浏览器下载链接等。希望本文能对您的学习和实践有所帮助。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/600673dffb81d47349e53c88