本文主要介绍 npm 包 node-red-contrib-habitica 的使用教程,该包可以让 Node-Red 用户在 Habitica 任务管理工具的平台上创建任务和获取任务列表。 如果你还不了解 Habitica 工具,请先移步到 Habitica 官网 学习基本用法。
安装
首先,你需要安装 Node-Red。如果你已经安装完成,你可以通过以下命令来全局安装 node-red-contrib-habitica 包:
npm install -g node-red-contrib-habitica
连接 Habitica 账户
在开始之前,你需要注册一个 Habitica 账户,然后我们就可以开始使用此 npm 包。
首先,新建一个 flow,添加一个 Habitica 节点,然后打开编辑器。点击「Authentication」选项卡,然后点击「Add new habitica-credentials」。
你需要在 Habitica 网站上申请一个 API key 和 API secret,然后将它们输入到相应的字段中。
Habitica 节点现在应该成功连接了你在上一步申请的账户,你可以从 Habitica 的「Tasks」API 上拉取任务列表、创建任务、完成任务等等。
获取任务
我们可以从 Habitica 获取一个任务的信息。在 Node-Red 中添加一个 HTTP Node,将其设置为 GET 请求,将 URL 设置为 http://localhost:1880/habitica-time/tasks
(端口应该可以根据你的 node-red 进程端口调整)。在 Habitica 节点中,设置「Action」为「GET Tasks」,参数如图所示:
你将在响应体中收到 Habitica 中所有的任务,节点将返回一个 JSON。
-- -------------------- ---- ------- - - ----- --------------------------------------- ------- ----- - ------ ------- -------- ----------- ------ ---------------- --- -------- --- ------- --- -------- ------ ------------ ------ ------------ --------------------------- ------------ --------------------------- -------- -- ---------- -- -- - ----- --------------------------------------- ------- --- ---------- ------- -------- ----------- ------ ---------------- --- -------- --- ------- --- -------- ------ ------------ ------ ------------ --------------------------- ------------ --------------------------- -------- -- ---------- -- - -
你可以在 Habitica API 文档 查看更多任务的信息和其他属性。
创建任务
同样的方式,你可以使用 Habitica 节点创建一个新任务。在这个例子中,我们将创建一个新任务,任务类型是「待办事项」。在 Node-Red 中添加一个 HTTP Node,将其设置为 POST 请求,将 URL 设置为 http://localhost:1880/habitica-time/tasks
,你将需要在 HTTP 节点中添加一个输入数据,这个数据结构可以参考下面示例的 JSON。
在 Habitica 节点中,设置「Action」为「Create Task」,参数如图所示:
-- -------------------- ---- ------- - ------------ ------ ------- ------- ---- -------- --- -------- ---------- ------- ------- ------- - ----------- ---------- - -
这应该修改 Node-Red 和 Habitica 的任务,并在 Node-Red 的输出面板中返回一个 JSON 返回值,如下所示:
-- -------------------- ---- ------- - ---------- ----- ------- - ----- --------------------------------------- ------- ------- ---- -------- --- -------- ---------- ------- ------- ----------- ---- -------- -- -------- ------ ------------ ------ ------- - ----------- ---------- -- -------- --- -------------- --------------------------- ---------- - - ----- --------------------------------------- ------- --------------------------- -------- - - -- ------------ - ----- --------------------------------------- ------- --- ----------- ------- -------------- ------ ------------------ ---------------- -- ----------------- - - - -
完成和删除任务
你可以使用 Habitica 节点完成一个任务或删除一个任务。在 Node-Red 中添加一个 HTTP Node,将其设置为 PUT 请求或 DELETE 请求,将 URL 设置为 http://localhost:1880/habitica-time/tasks/:taskId
,其中的 :taskId
是 Habitica 的任务 ID,你需要将其作为 URL 参数传递。在 Habitica 节点中,设置「Action」为「PUT Task Complete」或「DELETE Task」,如图所示:
结论
本文展示了如何使用 node-red-contrib-habitica 包与 Habitica 连接。你现在已经了解了如何使用连接到 Habitica API。你可以通过检查《Habitica API》文档的不同 endpoints,探索更多 Habitica 的功能和插件。
我们希望你能找到使用 Habitica 在个人和团队中更加高效地工作和学习的方法。祝你好运!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600563e581e8991b448e1382