只需简单5步,简化Jira API使用

1,580 阅读3分钟

随着对软件应用的需求不断增加,科技企业会发现很难管理多个项目。任务管理需要一个监控系统,由于涉及的人数众多,需要以一种良好的方式跟踪一个项目。 Jira已经成为一个强大的工作管理解决方案,适用于许多使用案例,从需求和测试案例管理到敏捷软件开发。

多年来,Jira 越来越受欢迎,在190多个国家有18万多客户在使用它。你可以通过使用多功能的Jira API(如REST APIs和Java APIs)来扩展Jira的能力,并根据你的业务需求进行调整。你可以使用Jira的API来创建应用程序,使Jira的互动自动化,创建Jira问题或建立任何其他形式的集成。

那么,你准备好进一步了解Jira APIs了吗?如果是,那就开始吧。在这篇文章中,你将了解更多关于Jira的信息,并探索它所提供的惊人功能。此外,你将了解Jira APIs,并学习使用Jira Cloud REST API创建Jira问题的详细步骤。因此,请继续阅读,以揭开Jira API的惊人世界。

目录

Jira简介

Jira API - Jira Logo

Jira 是一个满足你所有项目管理要求的一站式服务。它最初是一个软件开发的错误跟踪工具,现在已经成熟为一个问题跟踪和敏捷项目管理软件。它是由澳大利亚领先的软件公司Atlassian创建的,该公司专门为软件开发团队开发软件产品。

Jira 仪表板有很多方便的特点和功能,使处理问题变得轻而易举。另一方面,Jira已经发展成为一个强大的任务管理解决方案,适用于许多使用案例,从需求和测试案例管理到敏捷软件开发。Jira产品系列协助团队有效地管理他们的工作。Jira产品套件是为各种团队设计的,包括IT、运营、软件、商业和其他。

Jira的软件以云托管的SaaS即Jira Cloud以及自我管理的解决方案即Jira Server的形式提供。Jira云是为速度和易用性而设计的,而Jira服务器则提供更多的自主权和可定制的选项。Jira的成本对小团队来说是相当实惠的,但随着用户数量的增加,成本会急剧上升。

Jira的主要特点

Jira因其惊人的功能而成为开发者中最受欢迎的项目管理工具之一。让我们探讨一下Jira提供的一些关键功能。

  • 敏捷项目管理。 Scrum BoardsKanban Boards的所有功能都可以与Jira无缝连接。Jira还拥有各种报告工具,如烧毁/上升图冲刺报告速度图,使团队能够实时监控他们的进展。你可以使用Jira的敏捷路线图来规划长期的项目计划,确定瓶颈,并改善你的项目工作流程。

  • 工作流程定制。J ira可以被定制以满足任何要求,无论是项目管理问题跟踪还是任务管理。工作流程、报告、Scrum Board和其他组件也可以定制。

  • 强大的集成支持。开发人员可以使用多功能的RESTJava API,以及Atlassian Marketplace中的3000多个 附加组件和插件,这使得扩展Jira的功能并使其适合您的业务需求变得简单。因此,Jira可以无缝地集成到任何软件环境中,只要你的账户一创建,就可以使用。

  • 开发人员的丰富工具包。开发人员将可以使用Jira查询语言(JQL) ,使他们能够快速创建过滤器和操作。为了提供从积压到部署的可追溯性,Jira可以链接到BitBucketGitHub,并且可以建立新的工作流程来管理用户构建、测试和发布应用程序的多种方式。

  • 企业级的安全控制。Jira通过银行级别的安全和集中管理Jira软件和其他Atlassian云产品来保护数据和文件。管理员可以制定一个灵活的治理计划,不限制使用他们需要的工具或流程进行访问或协作。

  • **移动应用。**Jira的原生移动应用连接了安卓和iOS用户,使其成为在不同地点工作的大型和分布式团队的理想选择。

你觉得Jira很神奇吗?访问官方主页。

Jira APIs简介

Jira APIs

Jira REST APIs是用来远程连接Jira服务器应用程序的。对于问题和工作流程等基本功能,Jira服务器平台提供了一个REST API。Jira APIs可用于创建应用程序、自动化Jira互动,或建立任何其他形式的集成。

Jira REST APIs使用URI路由来让用户访问资源(数据实体)。你的应用程序提出一个HTTP请求,并解析答案,以使用REST API。Jira REST API用JSON进行通信,支持传统的HTTP方法,如GETPUTPOSTDELETE。REST API可用于Jira软件和Jira服务管理中的特定应用功能,如冲刺 (Jira软件)和客户端请求****(Jira服务管理)。

在访问Jira的数据时,有两个关键的安全概念需要考虑。

  • 认证 确定了调用者的身份。
  • 授权决定了哪些选项对调用者是可用的。应用程序或集成可以执行的操作受到用户的Jira权限的限制。

通过Jira REST API查询和更新Jira网站中的数据,你可以与Jira互动。Jira利用登录过程中使用的用户来授权对Jira REST API的请求。例如,如果一个用户有Jira的访问权和在Jira中创建问题的权限,他或她可以使用Jira REST API来创建一个问题。然而,如果调用的用户没有权限在Jira中执行特定的操作,他们将无法使用Jira API进行操作。

以下认证方法之一可用于Jira APIs

  • OAuth: 为了验证用户,OAuth利用了Jira提供的请求令牌。然而,与其他两种认证方法相比,设置这种认证需要更多的时间和精力,但它更加灵活和安全。

  • 基本认证 了进行认证,基本认证方法依赖于一组预定义的用户凭证。除了个人脚本或机器人等工具,不建议使用这种认证方法。它更容易设置,但它的安全性也差很多。

  • 基于Cookie的认证 浏览器中,Jira使用基于Cookie的认证方式。在使用浏览器调用REST API时,你可以依靠它(例如,通过JavaScript)。

用Hevo的无代码数据管道简化ETL和REST APIs

Hevo Data,一个无代码数据管道,帮助从任何数据源加载数据,如数据库,SaaS应用程序,云存储,SDK,和流服务,并简化ETL过程。它支持100多个数据源,包括40多个免费来源 ,如Jira。Hevo将数据加载到所需的数据仓库/目的地,丰富数据并将其转化为可分析的形式,而无需编写一行代码。Hevo支持REST APIs的强大和本地连接器 ,以帮助你轻松地统一数据。

Hevo的容错可扩展的 架构确保数据以安全、一致的方式处理,零数据损失,并支持不同形式的数据。Hevo允许你通过它的本地连接器从各种来源带来数据。然而,对于你需要从多个不同的应用程序或从内部的REST API带来数据的情况,你可以使用REST API源

免费开始使用HEV

看看为什么Hevo是最好的。

  • 安全 Hevo有一个容错架构,确保数据得到安全和一致的处理,零数据丢失。
  • 模式管理 Hevo消除了繁琐的模式管理任务,自动检测传入数据的模式并将其映射到目标模式。
  • 学习简单 Hevo,其简单和互动的用户界面,对新客户来说是非常简单的工作和执行操作。
  • Hevo是为扩展而建 随着来源的数量和你的数据量的增长,Hevo可以横向扩展,每分钟处理数百万条记录,而且延迟很小。
  • 增量数据加载 Hevo允许实时传输已修改的数据。这确保了两端带宽的有效利用。
  • 实时支持 Hevo团队全天候通过聊天,电子邮件和支持电话向客户提供特殊支持。
  • 实时监控 Hevo允许你监控数据流,并检查你的数据在某个特定时间点的位置。

今天就用Hevo简化你的ETL和数据分析吧!

使用Jira APIs创建Jira问题的步骤

Jira API - Jira Cloud REST APIs

图片来源

在本节中,你将学习如何使用Jira Cloud REST API创建一个Jira问题。因此,请遵循以下步骤来使用Jira APIs

第1步:创建一个Jira云账户

如果你已经有一个Jira云账户 ,那么就去Jira网站, 登录到你的账户。然而,如果你没有账户,你可以选择免费的Jira Cloud计划进行尝试,然后输入一个网站名称,如下图所示。点击 "继续"。

Jira API - Site name

图片来源

第2步:创建Jira API Token

要想用Atlassian云产品来验证一个脚本或其他程序,就需要一个API令 牌。按照下面的步骤创建Jira API Token。

  • 登录Atlassian平台,访问Jira云,或点击这里直接打开创建API令牌的页面。
  • 进入设置→API令牌 ,点击 "创建API令牌",如下图所示。

Jira API - Create API Token

图片来源

  • 在显示的窗口中为你的令牌输入一个独特而简洁的标签,然后点击创建。
  • 如下图所示,将令牌复制到你的剪贴板上,然后将其粘贴到你的脚本或其他地方来存储它。

Jira API - Copy API Token

图片来源

注意: 出于安全考虑,在关闭对话框后查看同一个API令牌是不可能的。如果有必要,你可以按照上述步骤创建一个新的令牌。

第3步:创建一个基本的Auth头

你现在可以使用你的API Token建立一个基本的Auth header。任何需要你登录的REST API调用都需要这个。按照下面的步骤来创建一个基本认证头。

  • 创建一个字符串,看起来像_useremail:api_token_。
  • 接下来,使用BASE64编码对该字符串进行编码。

对于Linux/Unix/MacOS。

echo -n user@example.com:api_token_string | base64

Windows 7和更高版本,使用Microsoft Powershell。

$Text = ‘user@example.com:api_token_string’
$Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
$EncodedText = [Convert]::ToBase64String($Bytes)
$EncodedText

base64编码的输出是你在下面步骤的_YourEncodedStringHere_部分所需要的。

第四步:开发你的Jira API调用

在这一步,你将创建一个简单的curl命令来调用你的REST API端点。你必须使用你的Jira Cloud实例的 _/rest/api/3/issue_端点来创建一个问题。该调用的结构如下。

curl --request POST \
  --url 'https://<your-jira-cloud-instance>/rest/api/3/issue' \
  --header 'Authorization: Basic YourEncodedStringHere' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{…}'

在上面的脚本中,你首先调用curl命令,告知你正在执行一个POST请求。在下一行,你将定义端点的URL,然后指定Jira用户,该用户将使用上面创建的编码的_useremail:api_token_字符串来授权调用。

接下来,你将指定应用程序的内容类型,即JSON。在这里你将输入实际的信息,这些信息将被用来生成你的新问题。比如说。

"fields": {
        "summary": "Hevo is awesome!",
        "issuetype": {
            "id": "10009"
        },
        "project": {
            "key": "TEST"
        },
        "description": {
            "type": "doc",
            "version": 1,
            "content": [
                {
                "type": "paragraph",
                "content": [
                    {
                    "text": "Description - Hevo is a No Code Data Pipeline",
                    "type": "text"
                    }
                ]
                }
            ]
        }
    }

上面的脚本将在项目中创建一个问题,项目名称为TEST,摘要为 "Hevo is awesome!"和 "描述--Hevo是一个无代码数据管道"的描述调用_issuetype_REST API端点,如下图所示,是获得问题类型ID的最简单方法。

curl --request GET \
  --url 'https://<your-jira-cloud-instance>/rest/api/3/issuetype' \
  --header 'Authorization: Basic YourEncodedStringHere' \
  --header 'Accept: application/json' \

上述脚本将为你提供所有问题类别的完整列表,以及它们的id,你可以从中选择你需要的类别。

第5步:创建你的问题

现在你所要做的就是运行你的curl命令,如果一切顺利的话,你应该得到这样的结果。

{
"id":"10052",
"key":"TEST-6",
"self":"https://pvandevoorde.atlassian.net/rest/api/3/issue/10052"
}

显示的是你刚刚生成的问题的ID、问题密钥和REST API端点。另外,你也可以简单地在你的Jira实例中查看,如下图所示。

Jira API - Jira Issue Created

图片来源

好样的!你刚刚使用Jira的API 创建了你的第一个问题。

总结

在这篇文章中,你探索了JiraJira APIs。更具体地说,你了解了Jira的主要功能,这些功能使它在开发者中如此受欢迎。此外,你还了解了使用Jira APIs的详细步骤。你使用Jira Cloud REST APIs在Jira中创建了你的第一个问题。

此外,从不同的数据源中提取复杂的数据,如数据库,SaaS应用程序,云存储,SDK,和流媒体服务,可能是相当具有挑战性和繁琐的,然而,像Hevo 这样简单的替代方案可以拯救你的日子!

访问hevo网站

Hevo数据是一个无需代码的数据管道,它提供了一种更快的方式将数据从100多个数据源(包括40多个免费源 ,如Jira)转移到你的数据仓库,并在BI工具中进行可视化。Hevo是完全自动化的,因此不需要你编码。它支持强大的本地REST APIs连接器,帮助你轻松地统一数据。 为你的数据仓库提供无需代码的数据管道