fogbugz.js 是一个用于 FogBugz API 的 JavaScript 包,可以在前端和后端使用。该包提供了一系列的方法,使得与 FogBugz 的交互变得更加方便。本文将介绍如何使用该包。
安装
安装 fogbugz.js 可以使用 npm,执行以下命令:
--- ------- ---------- ------
如果你使用的是 Yarn,可以执行以下命令:
---- --- ----------
使用
首先,需要引入 fogbugz.js 并创建一个 FogBugz 实例:
----- ------- - --------------------- ----- ------- - --- -------------------------------------- ------------
其中,'https://example.fogbugz.com' 是 FogBugz 的 URL,'API_TOKEN' 是你的 API token。你可以在 FogBugz 的个人设置中生成 API token。如果你想暴露你的 API token,你可以将其存储在一个环境变量中:
----- ------- - --- -------------------------------- ------------------------------
接下来,我们可以使用 FogBugz 实例来执行 FogBugz API。
示例
下面是一个使用 FogBugz API 来获取 FogBugz 中某个案件的信息的示例:
----- -------- ----------- - --- - ----- -------- - ----- ------------------------- - -- -- -- ----- ----- - ------------------- -- ------------- --- -- - ----- --- ----------- ----- --- ------- - ----- -------- - -------- ----- ------ - - --- --------------- ------ ---------------- ------- ---------------- - ------ ------ - ----- --- - ---------------- - - --------------------------- -- - --------------------- --
以上代码中,getCase
函数接受一个案件 ID,调用 FogBugz API 的 search
命令,获取案件信息。如果找不到该案件,将抛出异常。
命令
fogbugz.js 支持 FogBugz API 的所有命令。
command
command
命令是执行 FogBugz API 的主要命令。它接受两个参数:命令名称和命令参数。命令参数应该是一个对象。
例如,执行 search
命令:
------------------------- - -- ------ --
login
login
命令用于登录到 FogBugz。它接受三个参数:邮箱地址,密码和记住登录状态。
例如,登录到 FogBugz:
------------------------------------ ----------- ------
logout
logout
命令用于登出 FogBugz。
例如,登出 FogBugz:
----------------
authToken
FogBugz API 的每个请求都需要一个 API token。你可以使用 authToken
命令来获取 API token。
例如:
----- -------- - ----- -------------------
总结
通过阅读本文,你现在应该已经了解了如何使用 npm 包 fogbugz.js 来与 FogBugz 交互,在前端和后端使用 FogBugz API。
fogbugz.js 提供了一些可交互的方法,可以执行所有 FogBugz API 命令。通过学习这些方法,你可以轻松访问 FogBugz API,使你的工作更加高效。
希望本文对你有帮助!
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/80698