JIRA API Gem 技术文档
2024-12-26 06:01:24作者:侯霆垣
1. 安装指南
1.1 安装 jira-ruby Gem
在开始使用 JIRA API Gem 之前,您需要先安装 jira-ruby Gem。可以通过以下命令进行安装:
gem install jira-ruby
1.2 生成公钥证书
在运行测试之前,您需要生成一个公钥证书。可以通过以下命令生成:
rake jira:generate_public_cert
1.3 设置 JIRA SDK(Mac OS)
如果您在 Mac OS 上运行测试,需要先安装 Atlassian SDK。按照以下步骤进行安装:
- 访问 Atlassian SDK 安装指南,按照“Mac OSX Installer”部分的说明进行安装。
- 安装完成后,进入 SDK 的安装目录,运行以下命令启动 JIRA:
./bin/atlas-run-standalone --product jira
启动后,您可以通过 http://localhost:2990/ 访问 JIRA 管理界面,使用 admin:admin 登录。
2. 项目的使用说明
2.1 连接到 JIRA
首先,您需要配置连接参数以连接到 JIRA 实例。以下是一个示例配置:
options = {
  :private_key_file => "rsakey.pem",
  :context_path     => '',
  :consumer_key     => 'your_consumer_key',
  :site             => 'your_jira_instance_url'
}
client = JIRA::Client.new(options)
2.2 获取并显示项目
连接成功后,您可以获取所有项目并显示它们的键和名称:
projects = client.Project.all
projects.each do |project|
  puts "Project -> key: #{project.key}, name: #{project.name}"
end
2.3 使用字段名称
jira-ruby Gem 允许您通过自定义字段名称引用字段,而不是使用标识符。在使用之前,请确保映射字段:
client.Field.map_fields
old_way = issue.customfield_12345
# 注意:映射的方法采用 PascalCase 和 snake_case 结合的命名风格
new_way = issue.Special_Field
2.4 使用 JQL 查询
您可以使用 JIRA Query Language (JQL) 根据特定条件查找问题:
client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :Special_field, :created])
2.5 创建、更新、删除问题
创建问题
issue = client.Issue.build
labels = ['label1', 'label2']
issue.save({
  "fields" => {
    "summary" => "blarg from in example.rb",
    "project" => {"key" => "SAMPLEPROJECT"},
    "issuetype" => {"id" => "3"},
    "labels" => labels,
    "priority" => {"id" => "1"}
  }
})
更新/转换问题
issue = client.Issue.find("10002")
issue.save({"fields"=>{"summary"=>"EVEN MOOOOOOARRR NINJAAAA!"}})
issue_transition = issue.transitions.build
issue_transition.save!('transition' => {'id' => transition_id})
删除问题
issue = client.Issue.find('SAMPLEPROJECT-2')
issue.delete
3. 项目 API 使用文档
3.1 搜索用户
您可以使用以下代码搜索用户:
users = client.User.search('username')
users.each do |user|
  puts "User -> name: #{user.name}, email: #{user.emailAddress}"
end
3.2 获取问题的观察者
您可以通过以下代码获取问题的观察者:
issue = client.Issue.find('SAMPLEPROJECT-1')
watchers = issue.watchers
watchers.each do |watcher|
  puts "Watcher -> name: #{watcher.name}"
end
3.3 更改问题的分配者
您可以通过以下代码更改问题的分配者:
issue = client.Issue.find('SAMPLEPROJECT-1')
issue.save({"fields"=>{"assignee"=>{"name"=>"new_assignee"}}})
3.4 添加附件和评论
您可以通过以下代码向问题添加附件和评论:
issue = client.Issue.find('SAMPLEPROJECT-1')
issue.attachments.build.save!('file' => '/path/to/file')
issue.comments.build.save!('body' => 'This is a comment')
4. 项目安装方式
4.1 使用 OAuth 配置 JIRA
- 在 JIRA 中注册一个新的消费者。通过 JIRA 的“应用程序链接”管理界面创建新的应用程序链接。
- 在创建应用程序链接时,使用占位符 URL 或客户端 URL(例如 http://localhost:3000),并选择“通用应用程序”类型。
- 创建完成后,编辑配置并进入“传入身份验证”配置界面,选择 OAuth,并输入公钥和消费者密钥。
4.2 使用 HTTP Basic Auth 配置 JIRA
- 按照上述步骤在 JIRA 中设置新的应用程序链接。
- 无需设置“传入身份验证”,默认使用 HTTP Basic Auth。
4.3 使用 Cookie-Based Auth 配置 JIRA
- 设置 :auth_type为:cookie,并启用:use_cookies。
- 设置 :username和:password。
options = {
  :username           => 'username',
  :password           => 'pass1234',
  :site               => 'http://mydomain.atlassian.net:443/',
  :context_path       => '',
  :auth_type          => :cookie,
  :use_cookies        => true
}
client = JIRA::Client.new(options)
4.4 使用 Personal Access Tokens Auth 配置 JIRA
- 如果您的 JIRA 系统支持 Personal Access Token 授权,您需要设置 :default_headers包含 API Token。
options = {
  :site               => 'http://mydomain.atlassian.net:443/',
  :context_path       => '',
  :default_headers    => { 'Authorization' => "Bearer #{api_token}" },
  :auth_type          => :basic
}
client = JIRA::Client.new(options)
通过以上步骤,您可以成功安装、配置并使用 JIRA API Gem 进行 JIRA 系统的操作。
登录后查看全文 
热门项目推荐
 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
 MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00 MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00
 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
 Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00 Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile014
 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
 docs
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
263
2.53 K
 kernel
kerneldeepin linux kernel
C
24
6
 flutter_flutter
flutter_flutter暂无简介
Dart
554
124
 ops-math
ops-math本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
597
149
 pytorch
pytorchAscend Extension for PyTorch
Python
97
125
 cangjie_tools
cangjie_tools仓颉编程语言命令行工具,包括仓颉包管理工具、仓颉格式化工具、仓颉多语言桥接工具及仓颉语言服务。
C++
52
66
 ohos_react_native
ohos_react_nativeReact Native鸿蒙化仓库
JavaScript
220
301
 RuoYi-Vue3
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
602
 cangjie_compiler
cangjie_compiler仓颉编译器源码及 cjdb 调试工具。
C++
117
91
 Cangjie-Examples
Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
357
1.79 K