在前端开发中,经常需要使用到第三方库。npm 是全球最大的软件包管理系统,提供了数以万计的开源软件包,omdbjs 就是其中之一。omdbjs 是一个用于获取电影信息的 npm 包,支持查询电影信息、电影评论、电影明细等功能,避免了开发者需要从零开发类似功能的时间和精力浪费,提高开发效率。
安装 omdbjs
使用 npm 安装 omdbjs 非常方便,只需要在终端输入以下命令即可:
npm install omdbjs --save
使用 omdbjs
使用 omdbjs 需要首先获取一个 API key,并在使用时传入。API key 可以在 http://www.omdbapi.com/ 上免费申请,一个 API key 每天可以免费使用 1 万次。
-- -------------------- ---- ------- ----- ---- - ------------------ ----- ------ - ------------- -- ------ --- --- ------------ ------------ --------- ------------ - ----- ------- -- -------- ----- ---------- -- -- - --------------------- -- ------------ -- -------------- -- - ------------------- ---
上面的代码通过传入 API key 初始化了 omdbjs,然后使用 search 方法搜索电影名称为 The Shawshank Redemption 的电影,搜索结果只包含 type 为 movie 的电影,然后输出第一部搜索结果的信息。这里使用了 promise 异步编程方式,支持使用 async/await 等更加简洁的编写方式。
omdbjs API 详解
omdbjs 提供的 API 相对较多,这里简单介绍几个常用的 API。
search
搜索电影信息,接收两个参数:搜索关键字和可选参数 options。
omdb(apiKey).search('The Shawshank Redemption', { type: 'movie' })
getByIdentifier
根据 IMDb ID 或者电影名称获取电影信息,接收两个参数:要查找的电影 IMDb ID 或者电影名称和可选参数 options。
omdb(apiKey).getByIdentifier('tt0111161')
getByName
根据电影名称获取电影信息,接收两个参数:要查找的电影名称和可选参数 options。
omdb(apiKey).getByName('The Shawshank Redemption')
getBySearchTerm
根据搜索关键字获取电影信息,接收两个参数:要查找的搜索关键字和可选参数 options。
omdb(apiKey).getBySearchTerm('The Shawshank Redemption')
高级查询
除了上述常用的查询 API,omdbjs 还支持更加细致的高级查询,如下:
// 按照年份搜索电影 omdb(apiKey).getPage(2, { y: 2021 }) // 按照电影类型和年份搜索电影 omdb(apiKey).getPage(2, { y: 2021, type: 'movie' }) // 按照电影类型、年份和分页获取电影 omdb(apiKey).getPage(2, { y: 2021, type: 'movie' }, { page: 1, limit: 10 })
整个 API 详细的使用方法可以在官方 API 文档中查看:https://omdbapi.com/documentation。
思考与总结
omdbjs 提供了简单方便的方法来获取电影信息,大大提升了开发效率。通过学习 omdbjs,我们也了解到 npm 的强大,npm 上提供了大量优秀的开源软件包,适当使用可以节省开发时间,提高开发效率。此外,也需要更加注重 API 安全相关问题,避免因为 API 泄露而产生一系列的安全问题。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066fae3d1de16d83a672cb