npm 包 npr-api 使用教程

简介

npr-api 是一个用于访问美国国家公共广播电台（National Public Radio，简称 NPR）开放 API 的 Node.js 模块。NPR 提供了大量多样化的数据，如新闻报道、音频、博客、电视和电台节目等，开发者可以通过 NPR 的 API 轻松访问这些数据。

在本篇文章中，我们将探讨如何使用 npr-api 包，以及如何利用 NPR 的 API 获取数据。

安装

要使用 npr-api，只需在您的项目文件夹中运行以下命令：

npm install npr-api

安装完成后，您可以通过 require() 函数来在项目中引入 npr-api：

const nprApi = require('npr-api');

配置

在使用 npr-api 之前，您需要先申请一个 NPR API Key。申请步骤如下：

1. 访问 https://dev.npr.org/ 并点击 "Get Started"
2. 注册一个账户或者登录您的账户
3. 在 "Create a New App" 菜单下创建一个新的应用程序
4. 复制生成的 API Key，并确保保管好您的 API Key，不要分享给他人。

现在，您可以通过以下代码配置 npr-api 模块：

const nprApi = require('npr-api');

// 初始化 NPR API Key
nprApi.init({
  apiKey: 'YOUR_API_KEY'
});

使用

获取新闻故事

要获取 NPR 最新的新闻报道，可以使用 nprApi.getNewsStories() 函数。此函数需要传递一个对象作为参数，指定要获取数据的详细信息：

nprApi.getNewsStories({
  topicId: '1001',
  date: '2022-09-28'
}).then(result => {
  console.log(result);
}).catch(err => {
  console.log(err);
});

参数说明：

• topicId - 指定新闻主题的 ID，如：1001（美国新闻）、1003（世界新闻）、1017（科技）、1019（商业）等。默认值：1001（美国新闻）。
• date - 指定要获取新闻数据的日期。默认值：当前日期。

函数返回结果说明：

• stories - 新闻故事的数组，每个故事都包含了以下信息：
  • id - 故事唯一标识符
  • title - 故事标题
  • teaser - 故事的简短介绍
  • link - 故事的链接
  • pubDate - 发布日期，格式：YYYY-MM-DD HH:mm:ss

获取主题故事

要获取指定主题下的最新故事，可以使用 nprApi.getTopicStories() 函数。此函数需要传递一个对象作为参数，指定要获取数据的详细信息：

nprApi.getTopicStories({
  topicId: '1001',
  date: '2022-09-28'
}).then(result => {
  console.log(result);
}).catch(err => {
  console.log(err);
});

参数说明：

• topicId - 指定主题的 ID，如：1001（美国新闻）、1003（世界新闻）、1017（科技）、1019（商业）等。默认值：1001（美国新闻）。
• date - 指定要获取数据的日期。默认值：当前日期。

函数返回结果说明：

• stories - 故事的数组，每个故事都包含了以下信息：
  • id - 故事唯一标识符
  • title - 故事标题
  • teaser - 故事的简短介绍
  • link - 故事的链接
  • pubDate - 发布日期，格式：YYYY-MM-DD HH:mm:ss
  • thumbnail - 缩略图链接

获取电台节目

要获取 NPR 最新的电台节目，可以使用 nprApi.getPrograms() 函数。此函数需要传递一个对象作为参数，指定要获取数据的详细信息：

nprApi.getPrograms({
  date: '2022-09-28'
}).then(result => {
  console.log(result);
}).catch(err => {
  console.log(err);
});

参数说明：

• date - 指定要获取节目数据的日期。默认值：当前日期。

函数返回结果说明：

• programs - 节目的数组，每个节目都包含了以下信息：
  • id - 节目唯一标识符
  • title - 节目标题
  • teaser - 节目的简短介绍
  • link - 节目的链接
  • pubDate - 发布日期，格式：YYYY-MM-DD HH:mm:ss
  • programDate - 节目日期，格式：YYYY-MM-DD
  • thumbnail - 缩略图链接

结论

通过使用 npr-api 包，我们可以轻松访问 NPR 的多样化数据，包括新闻报道、音频、博客、电视和电台节目等。同时，本文也介绍了如何申请 NPR API Key、配置 npr-api 模块，并使用三个不同函数获取 NPR 的数据。感谢你阅读这篇教程，希望对你的 Node.js 开发有所帮助。更多详细信息可以参考 npr-api 的GitHub 托管地址。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f933d1de16d83a66bd6