简化Jira API的使用,5个简单的步骤(2)

发表于:2022-1-14 09:18

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:方石剑    来源:稀土掘金

  使用Jira APIs创建Jira问题的步骤
  第1步:创建一个Jira云账户
  如果你已经有一个Jira云账户 ,那么就去Jira网站, 登录到你的账户。然而,如果你没有账户,你可以选择免费的Jira Cloud计划进行尝试,然后输入一个网站名称,如下图所示。点击 "继续"。
  第2步:创建Jira API Token
  要想用Atlassian云产品来验证一个脚本或其他程序,就需要一个API令 牌。按照下面的步骤创建Jira API Token。
  · 登录Atlassian平台,访问Jira云,或点击这里直接打开创建API令牌的页面。
  · 进入设置→API令牌 ,点击 "创建API令牌",如下图所示。
  · 在显示的窗口中为你的令牌输入一个独特而简洁的标签,然后点击创建。
  · 如下图所示,将令牌复制到你的剪贴板上,然后将其粘贴到你的脚本或其他地方来存储它。
  注意: 出于安全考虑,在关闭对话框后查看同一个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 创建了你的第一个问题。

  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号