npm 包 openweathermapapi 使用教程

随着移动设备和互联网的普及，天气应用也成为了我们生活中必不可少的工具之一。而 openweathermapapi 就是一款常用的获取天气数据的 npm 包，许多前端开发者基于它来构建自己的天气应用。本篇文章将向您介绍 openweathermapapi 的使用方法以及一些常见问题解决方案。

安装 openweathermapapi

打开命令终端，进入你的项目根目录，执行以下命令：

npm install openweathermapapi --save

这里采用了 --save 选项，它的作用是将 openweathermapapi 以依赖项的方式安装到项目下，以后在执行 npm install 的时候不需要再次安装。

使用 openweathermapapi

在使用 openweathermapapi 前，你需要在 openweathermap 的官网上注册并获取你的 API key。

const OpenWeatherMapAPI = require('openweathermapapi');
const openWeatherMapAPI = new OpenWeatherMapAPI('YOUR_API_KEY');

这里我们通过 require 方法将包引入，并使用获取的 API key 创建 openWeatherMapAPI 实例。

接下来，你可以使用该实例访问一系列 API 方法，获取各种天气数据。例如，以下命令可以获取北京的天气数据：

openWeatherMapAPI.getWeatherDataByCityName('Beijing')
    .then(console.log)
    .catch(console.error);

其中，.then 方法和 .catch 方法用于处理异步操作的结果或错误。

API 列表

openweathermapapi 提供了一系列可供调用的 API 方法，接下来将对这些方法进行一一介绍。

getWeatherDataByCityName(cityName[, country])

通过城市名称获取天气数据。

• cityName：必填参数，表示城市名称。
• country：可选参数，表示城市所在国家的 ISO 3166 代码，缺省值为 undefined。

openWeatherMapAPI.getWeatherDataByCityName('Beijing', 'CN')
    .then(console.log)
    .catch(console.error);

getWeatherDataByCityId(cityId)

通过城市 ID 获取天气数据。

• cityId：必填参数，表示城市 ID。

openWeatherMapAPI.getWeatherDataByCityId(1816670)
    .then(console.log)
    .catch(console.error);

getWeatherDataByCoordinates(latitude, longitude)

通过经纬度获取天气数据。

• latitude：必填参数，表示纬度。
• longitude：必填参数，表示经度。

openWeatherMapAPI.getWeatherDataByCoordinates('39.9', '116.4')
    .then(console.log)
    .catch(console.error);

getForecastDataByCityName(cityName[, country][, cnt])

通过城市名称获取未来若干小时的天气预报。

• cityName：必填参数，表示城市名称。
• country：可选参数，表示城市所在国家的 ISO 3166 代码，缺省值为 undefined。
• cnt：可选参数，表示获取的小时数，默认值为 40。

openWeatherMapAPI.getForecastDataByCityName('Beijing', 'CN')
    .then(console.log)
    .catch(console.error);

getForecastDataByCityId(cityId[, cnt])

通过城市 ID 获取未来若干小时的天气预报。

• cityId：必填参数，表示城市 ID。
• cnt：可选参数，表示获取的小时数，默认值为 40。

openWeatherMapAPI.getForecastDataByCityId(1816670)
    .then(console.log)
    .catch(console.error);

getForecastDataByCoordinates(latitude, longitude[, cnt])

通过经纬度获取未来若干小时的天气预报。

• latitude：必填参数，表示纬度。
• longitude：必填参数，表示经度。
• cnt：可选参数，表示获取的小时数，默认值为 40。

openWeatherMapAPI.getForecastDataByCoordinates('39.9', '116.4')
    .then(console.log)
    .catch(console.error);

getForecastDailyDataByCityName(cityName[, country][, cnt])

通过城市名称获取未来若干天的每日天气预报。

• cityName：必填参数，表示城市名称。
• country：可选参数，表示城市所在国家的 ISO 3166 代码，缺省值为 undefined。
• cnt：可选参数，表示获取的天数，默认值为 7。

openWeatherMapAPI.getForecastDailyDataByCityName('Beijing', 'CN', 10)
    .then(console.log)
    .catch(console.error);

getForecastDailyDataByCityId(cityId[, cnt])

通过城市 ID 获取未来若干天的每日天气预报。

• cityId：必填参数，表示城市 ID。
• cnt：可选参数，表示获取的天数，默认值为 7。

openWeatherMapAPI.getForecastDailyDataByCityId(1816670, 10)
    .then(console.log)
    .catch(console.error);

getForecastDailyDataByCoordinates(latitude, longitude[, cnt])

通过经纬度获取未来若干天的每日天气预报。

• latitude：必填参数，表示纬度。
• longitude：必填参数，表示经度。
• cnt：可选参数，表示获取的天数，默认值为 7。

openWeatherMapAPI.getForecastDailyDataByCoordinates('39.9', '116.4', 10)
    .then(console.log)
    .catch(console.error);

常见问题解决

如何处理 API 中返回的时间戳？

openweathermapapi 返回的时间戳是 UTC 时间格式的数值，你可以像下面这样进行处理：

const date = new Date(timestamp * 1000);

其中，timestamp 表示时间戳的值，1000 是毫秒数转换成秒数的系数。

如何获取多语言数据？

openweathermapapi 默认是以英文为主的，你可以在 API 调用中设置 lang 参数获取数据的多语言版本，例如：

openWeatherMapAPI.getWeatherDataByCityName('Beijing', 'CN', 'zh_cn')
    .then(console.log)
    .catch(console.error);

结语

通过本文的介绍，我们了解了 openweathermapapi 的基本用法和常见问题解决方案。希望本文能够帮助您在前端开发中更好地运用 openweathermapapi。如果您有任何疑问或建议，欢迎在评论区中留言。

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