🚀 Jira 服务器

Jira 服务器是一个强大的工具，可用于管理项目中的问题。它支持创建、更新问题，还能进行批量操作，并且可以自定义配置，满足多样化的需求。

🚀 快速开始

安装与配置

1. 克隆仓库

   git clone https://github.com/your-repository.git
   cd jira-server
   

2. 安装依赖

   npm install
   

3. 设置环境变量
   • 创建 .env 文件并添加以下内容：

   JIRA_HOST=你的Jira实例地址
   JIRA_EMAIL=你的Jira邮箱
   JIRA_API_TOKEN=你的Jira API令牌
   

4. 启动服务器

   npm start
   

✨ 主要特性

核心功能

• 创建问题

  {
    "issue": {
      "fields": {
        "summary": "问题标题",
        "description": "问题描述",
        "status": "未解决",
        "priority": "高优先级",
        "assignee": { "id": "用户ID" },
        "issuetype": { "id": "问题类型ID" }
      }
    }
  } 
  

• 更新问题

  {
    "issueKey": "项目-123",
    "fields": {
      "summary": "新标题",
      "status": "已解决"
    }
  }
  

💻 使用示例

操作指南

获取问题列表

curl --user ${JIRA_EMAIL}:${JIRA_API_TOKEN} \
     --header "Content-Type: application/json" \
     --request GET \
     "https://${JIRA_HOST}/rest/api/2/search?jql=project%20=%22项目名称%22"

获取单个问题

curl --user ${JIRA_EMAIL}:${JIRA_API_TOKEN} \
     --header "Content-Type: application/json" \
     --request GET \
     "https://${JIRA_HOST}/rest/api/2/issue/项目-123"

高级用法

批量操作

创建多个问题

{
  "issues": [
    {
      "fields": {
        "summary": "问题1",
        "description": "描述1"
      }
    },
    {
      "fields": {
        "summary": "问题2",
        "description": "描述2"
      }
    }
  ]
}

更新多个问题

{
  "issueKeys": ["项目-123", "项目-124"],
  "fields": {
    "status": "已解决"
  }
}

自定义配置

自定义字段

在 JIRA_CUSTOM_FIELDS 环境变量中指定自定义字段：

JIRA_CUSTOM_FIELDS=summary,description,status,priority,assignee,issuetype

请求示例

创建问题时包含自定义字段

{
  "issue": {
    "fields": {
      "customfield_12345": "自定义值",
      "priority": { "id": "P1" }
    }
  }
}

📚 详细文档

贡献指南

提交代码

1. 创建功能分支

   git checkout -b feature/新功能
   

2. 提交更改

   git add .
   git commit -m "添加新功能"
   git push origin feature/新功能
   

3. 发起拉取请求
   • 访问 GitHub 仓库
   • 点击 "New Pull Request"
   • 填写相关信息并提交

代码风格

• 遵循 JavaScript 标准
• 使用有意义的变量名
• 注重代码可读性

参考资料

• Jira REST API：官方文档
• Node.js：官方网站
• npm：包管理器

📄 许可证

本项目遵循 MIT 协议。
版权所有 (c) 2023, Your Name.