什么是 ws-yummly
ws-yummly 是基于 Node.js 的一个 npm 包，它提供了一个 API，用于从 Yummly 网站上获取美食菜谱信息。Yummly 是一个美食社交网站，用户可以在网站上搜索、分享、保存喜爱的美食菜谱。
ws-yummly 提供了一种简单而有效的方式，方便我们从 Yummly 获取数据。通过 ws-yummly 的 API，我们可以在我们的项目中轻松地获取菜谱信息，同时还可以根据食谱名称、偏好、烹饪技巧等条件进行搜索。
如何使用 ws-yummly
安装
ws-yummly 是一个 npm 包，因此我们可以使用 npm 命令进行安装。
npm install ws-yummly
使用
在我们的项目中引入 ws-yummly 包，并创建一个 Yummly 实例。
const Yummly = require('ws-yummly');
const yummly = new Yummly(apiKey, apiId);其中 apiKey 和 apiId 分别是 Yummly 的 API 密钥和 ID。获取这些信息的最简单方式是创建一个 Yummly 开发者账户，注册并获取访问密钥。在获取好 API 密钥和 ID 后，就可以在我们的项目中使用 Yummly 实例了。
ws-yummly 的主要使用场景是菜谱搜索，因此，菜谱搜索会是我们接触 Yummly API 最频繁的方法。下面，我们将介绍如何使用 ws-yummly 进行菜谱搜索。
菜谱搜索
菜谱搜索是 Yummly API 最常用的功能。我们可以根据食谱名称、偏好、烹饪技巧等条件进行搜索，从而得到符合条件的美食菜谱。下面的代码演示了如何使用 ws-yummly 进行菜谱搜索。
-- -------------------- ---- ------- --------------- -- ------------ -- ------- ----------- --- ---------- --- -- ---- -- --- ------ -- -- --- - ----- ---------------- ----- -- ---------- -------------- -------------------- --------- -- -------- ---- ------ --- --------------- --------------------------- -- ------- -------- --- --------------- ---------------------------- -- ----------- ------------------- --------- -- ---------- ---------------------- ---- -- ------- - -- -------------- -- ---------------------
在上述代码中，我们通过 Yummly 实例的 search 方法进行了搜索，该方法接收一个包含搜索条件的对象。其中，q 属性用于指定搜索的菜谱名称，maxResult 和 start 属性用于指定返回的记录数和起始位置，requirePictures 属性用于只返回包含图片的菜谱。allowedCourse、excludedCourse、allowedCuisine 和 excludedIngredient 属性分别用于指定搜索的烹饪课程、菜系和食材。maxTotalTimeInSeconds 属性用于指定搜索的最长烹饪时间。
菜谱获取
搜索菜谱后，我们可以使用菜谱的 ID 获取完整的菜谱信息。下面的代码演示了如何使用菜谱 ID 获取菜谱信息。
yummly.recipe(recipeId).then(result => console.log(result));
在上述代码中，我们通过 Yummly 实例的 recipe 方法获取了菜谱信息。该方法接收菜谱的 ID 作为参数。
食材搜索
除了菜谱搜索，我们还可以使用 ws-yummly 进行食材搜索。下面的代码演示了如何使用 ws-yummly 进行食材搜索。
-- -------------------- ---- ------- ----------------------------------- -- ---------- -- --------- ----------------- --- -- ----------------- ------------------- --- -- --------------- ---------- --- -- ---- -- --- ------ -- -- --- - ----- ---------------- ----- -- ---------- -------------- -------------------- --------- -- -------- ---- ------ --- --------------- --------------------------- -- ------- -------- --- --------------- ---------------------------- -- ----------- ---------------------- ---- -- ------- - -- -------------- -- ---------------------
在上述代码中，我们通过 Yummly 实例的 searchRecipesByIngredients 方法进行食材搜索，该方法接收一个包含搜索条件的对象。其中，q 属性用于指定搜索的关键词，allowIngredients 和 excludeIngredients 属性分别用于指定允许使用和排除使用的食材。其余属性的用法和菜谱搜索相同。
总结
本篇文章介绍了 ws-yummly 的基本使用方法，包括菜谱搜索、菜谱获取和食材搜索。通过 ws-yummly，我们可以轻松地从 Yummly 网站获取美食菜谱信息，并在我们的项目中使用。通过本篇文章的学习，我们可以更好地应用 ws-yummly 进行菜谱搜索，并逐步掌握 Yummly API 的使用方法。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671178dd3466f61ffe678