简介
he-youtrack-lib 是一款适用于前端开发的 npm 包，该包封装了 YouTrack REST API 接口，方便前端开发人员进行 YouTrack 系统的操作。
本教程将详细介绍如何使用 he-youtrack-lib npm 包，包括安装、使用和示例演示。
安装
使用 npm 命令进行安装：
npm install he-youtrack-lib
使用
初始化
在项目中引入 he-youtrack-lib 包，并进行初始化：
import { YouTrack } from 'he-youtrack-lib';
const youtrack = new YouTrack({
baseUrl: 'http://localhost:8080', // YouTrack 的基本 URL
token: 'perm:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // 授权 token
});例子：获取我的所有问题
youtrack.issues
.query({
filter: 'for: me',
})
.then((issues) => {
console.log(issues);
});例子：获取指定问题的详细信息
youtrack.issues
.get('ABC-123')
.then((issue) => {
console.log(issue);
});API
以下为 YouTrack 类中常用的 API，更多详细信息请查看官方文档：
Issues API
query
查询问题列表。
youtrack.issues.query({
filter?: string;
after?: string;
before?: string;
max?: number;
fields?: string[];
select?: string;
})get
获取指定问题的详细信息。
youtrack.issues.get(issueId: string)
create
创建新的问题。
-- -------------------- ---- ------- ------------------------ -------- ------- ------------- ------- -------- ------- ---------- ------- ------ ------- ----------- ------- ---------- ------- -------------- -------------- ----- --
update
更新指定问题的信息。
-- -------------------- ---- -------
-----------------------
-------- -------
-
--------- -------
------------- -------
--------- -------
---------- -------
------ -------
----------- -------
---------- -------
-------------- -------------- -----
-
-delete
删除指定问题。
youtrack.issues.delete(issueId: string)
Projects API
query
查询项目列表。
youtrack.projects.query({
skip?: number;
take?: number;
fields?: string[];
select?: string;
})get
获取指定项目的详细信息。
youtrack.projects.get(projectId: string)
create
创建新的项目。
youtrack.projects.create({
name: string;
description?: string;
owner?: string;
archived?: boolean;
isImporting?: boolean;
})update
更新指定项目的信息。
-- -------------------- ---- -------
-------------------------
---------- -------
-
------ -------
------------- -------
------- -------
---------- --------
------------- --------
-
-delete
删除指定项目。
youtrack.projects.delete(projectId: string)
结束语
通过本教程，相信读者已经学会如何使用 he-youtrack-lib npm 包，可以方便地在前端开发中使用 YouTrack REST API 接口。
在开发过程中遇到问题时，可以参考本教程中的 API 文档或查看官方文档进行解决。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671d630d0927023822c6c