简介
iucn-red-list 是一个 npm 包,提供了访问国际自然保护联盟(IUCN)红色名录(Red List)的 API 接口。通过这个包,前端开发者可以在自己的项目中方便地获取物种分类、濒危等级、栖息地和威胁因素等信息,以及根据查询条件获取符合条件的物种信息。
安装
使用 iucn-red-list 前,需要先安装 Node.js 和 npm。安装完这两个工具后,在命令行中输入:
npm install iucn-red-list
即可安装 iucn-red-list 包。
使用方法
使用 iucn-red-list 包,在项目中需要先导入这个包:
const iucn = require('iucn-red-list')
要访问 IUCN Red List 的 API,需要一组访问密钥。你可以在 IUCN 官网申请获得。
接下来,使用这个包提供的方法访问 API:
获取物种信息
iucn.getSpecies('Panthera tigris', <your_app_key>, <your_app_secret>)
该函数接受三个参数:
- speciesName:需要查询的物种名称。
- appKey:你在 IUCN 上申请的应用密钥。
- appSecret:你在 IUCN 上申请的应用密钥对应的密钥。
该方法返回一个 Promise,Promise 的 resolved value 是查询到的物种信息。
获取物种分类
iucn.getTaxonomy('Panthera tigris', <your_app_key>, <your_app_secret>)
该函数接受三个参数:
- speciesName:需要查询的物种名称。
- appKey:你在 IUCN 上申请的应用密钥。
- appSecret:你在 IUCN 上申请的应用密钥对应的密钥。
返回一个 Promise,Promise 的 resolved value 是查询到的物种的分类信息。
获取濒危等级信息
iucn.getThreatStatus('Panthera tigris', <your_app_key>, <your_app_secret>)
该函数接受三个参数:
- speciesName:需要查询的物种名称。
- appKey:你在 IUCN 上申请的应用密钥。
- appSecret:你在 IUCN 上申请的应用密钥对应的密钥。
返回一个 Promise,Promise 的 resolved value 是查询到的物种的濒危等级信息。
按照查询条件获取物种信息
iucn.searchSpecies(<parameters>, <your_app_key>, <your_app_secret>)
该函数接受三个参数:
- parameters:一个对象,包含了你需要查询的条件。
- limit:查询结果的数量限制。
- offset:查询结果的偏移量。
- taxonid:分类编号。
- category:濒危等级。
- appKey:你在 IUCN 上申请的应用密钥。
- appSecret:你在 IUCN 上申请的应用密钥对应的密钥。
返回一个 Promise,Promise 的 resolved value 是查询到的物种信息列表。
示例代码
以下代码可以作为使用 iucn-red-list 包的示例:
-- -------------------- ---- ------- ----- ---- - ------------------------ ----- ------ - -------------- ----- --------- - ----------------- ------------------------- -------- ------- ---------- --------- -- - ---------------- -- ---------- -- - ------------------ --
在实际使用中,替换掉 <your_app_key>
和 <your_app_secret>
成为你在 IUCN 上申请得到的应用密钥和密钥即可。
总结
通过本篇教程,你已经了解了 iucn-red-list 包的使用方法,并且可以根据自己的需要获取物种信息。这个包对于保护生态环境、了解物种濒危现状等方面都有重要的作用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562e581e8991b448e07ef