npm 包 @atlassian/bitbucket-server 使用教程

阅读时长 6 分钟读完

本文将介绍如何使用 npm 包 @atlassian/bitbucket-server 进行 Bitbucket Server 的操作。Bitbucket Server 是一款 self-hosted 的 Git 版本控制软件,可以用于托管代码库及代码协作。@atlassian/bitbucket-server 封装了 Bitbucket Server 的 RESTful API,可以通过 JavaScript 操作 Bitbucket Server 进行代码库及用户的管理等操作。

安装

@atlassian/bitbucket-server 可以通过 npm 进行安装:

基本使用

在使用 @atlassian/bitbucket-server 前,需要先获得 Bitbucket Server 的账号、密码以及 REST API 的基础 URL。以下是一个基本的使用示例:

-- -------------------- ---- -------
----- --------------- - ---------------------------------------
----- ------ - ------------------------------
  -------- ----------------------------------------------
  --------- ----------------
  --------- ---------------
---

------------------------- --------- -- -
  -- ----- -
    -------------------- -------- ----- ------- --------- ---------
    -------
  -

  ------------------------ -----------------
---

在上例中,使用 createClient 方法创建了一个 Bitbucket Server 客户端,并传入 baseUrl、username 和 password 参数,这些参数分别代表 Bitbucket Server REST API 的基础 URL、账号和密码。之后,通过 client.projects.get 方法获取了所有项目的信息,将结果输出到控制台。

TypeScript 支持

@atlassian/bitbucket-server 支持 TypeScript,安装方法与 JavaScript 相同:

然后,在 TypeScript 中可以直接使用 @atlassian/bitbucket-server

-- -------------------- ---- -------
------ - ------------ - ---- ------------------------------

----- ------ - --------------
  -------- ----------------------------------------------
  --------- ----------------
  --------- ---------------
---

------------------------- --------- -- -
  -- ----- -
    -------------------- -------- ----- ------- --------- ---------
    -------
  -

  ------------------------ -----------------
---

操作示例

获取所有项目

新建项目

-- -------------------- ---- -------
----- ---------- - -
  ---- -------------
  ----- ---- ---------
  ------------ -- --- --------
--

---------------------------------- ----- --------- -- -
  -- ----- -
    -------------------- -------- ----- -------- -------- ---------
    -------
  -

  ---------------- ------- ---------- ----------
---

获取项目下所有仓库

-- -------------------- ---- -------
-------------------------
  ----------- ------------
-- ----- --------- -- -
  -- ----- -
    -------------------- -------- ----- ------- ------------- ---------
    -------
  -

  ---------------------------- -----------------
---

新建仓库

-- -------------------- ---- -------
----- ------------- - -
  ----- -----------------
  ------ ------
  --------- -----
  -------- -
    ---- ------------
  -
--

----------------------------------------- ----- --------- -- -
  -- ----- -
    -------------------- -------- ----- -------- ----------- ---------
    -------
  -

  ---------------- ---------- ---------- ----------
---

总结

本文介绍了如何使用 npm 包 @atlassian/bitbucket-server 进行 Bitbucket Server 的操作。通过 npm 安装后,可以方便地进行代码库及用户的管理等操作。此外,@atlassian/bitbucket-server 还支持 TypeScript,并且提供了一些常用操作的示例。对于需要自行维护 Bitbucket Server 的小组,通过掌握本文的内容,可以更加高效地进行 Git 版本控制。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/141945