Yelp-API 是一个用于获取 Yelp 商家信息的 npm 包，可以帮助开发者更方便地获取外卖、餐馆和酒吧等商家信息。本篇文章将为读者详细介绍如何使用 Yelp-API，并提供示例代码和使用指南。
安装
要使用 Yelp-API，首先需要在项目中安装该 npm 包。可以通过 NPM 或 Yarn 安装：
NPM：
npm install yelp-api --save
Yarn：
yarn add yelp-api
获取 Yelp API Key
在使用 Yelp-API 之前，需要获取 Yelp API Key。可以按照以下步骤获取：
- 创建 Yelp 账号或登录；
- 进入 Yelp Fusion API 管理面板；
- 创建一个新的 Yelp 应用程序；
- 在创建应用程序后，可以在“应用程序信息”部分找到 Yelp API Key。
使用 Yelp-API
一旦安装了 Yelp-API 并获取了 Yelp API Key，就可以开始使用 Yelp-API 来获取商家信息了。下面是一个简单的例子：
-- -------------------- ---- -------
----- ---- - --------------------
----- ---- - --- ------
------- --------------------
---
------------- ----- ------- --------- ---- ---------- --
-------------- -- -
--------------------
--
------------ -- -
-------------------
---这是一个使用 Yelp-API 的基本例子。在此代码中，我们使用 yelp-api 模块导入 Yelp 类，并使用我们的 API Key 创建了一个新实例。
接着，我们使用 search 方法查询餐馆信息。该方法接收一个 JSON 对象，用于指定查询条件，包括餐馆名称、地址、城市、州等信息。在本例中，我们搜索 San Francisco 地区的餐馆信息。如果查询成功，将返回一个 JSON 对象，其中包含了餐馆信息。
如果请求失败，可以使用 catch 方法捕获错误并输出错误信息。
查询参数
Yelp-API 还提供了许多可用于查询商家信息的参数。下面是几个常用参数的例子：
term：商家名称或关键字；location：商家所在城市；categories：商家类别；price：价格范围（1-4）；rating：评分范围（1-5）；sort_by：排序方式（最佳匹配、评价最高、最新的等）。
下面是一个更复杂的例子，使用了多个参数：
yelp.search({
term: 'food',
categories: 'Japanese,Chinese',
price: '1,2,3',
rating: '4.0,5.0',
limit: 10,
location: 'San Francisco',
})使用这些参数将返回更加精确的商家信息。
结语
在本篇文章中，我们介绍了如何使用 npm 包 Yelp-API，并提供了一些使用指南和示例代码。Yelp-API 可以帮助开发者更方便地获取商家信息，提升工作效率。希望本文可以对读者在使用 Yelp-API 上提供一些帮助和指导。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056fd881e8991b448e7bcd