Request를 통한 JIRA REST API 사용방법

Request를 통한 JIRA REST API 사용방법

Python
Jira
Request를 통한 JIRA REST API 사용방법
Author

gabriel yang

Published

October 8, 2024


JIRA REST API 사용을 위한 준비

JIRA는 소프트웨어 개발 및 프로젝트 관리 도구로, Atlassian에서 제공하는 REST API를 통해 다양한 작업을 자동화하거나 데이터를 조회할 수 있습니다. 이 글에서는 Python의 requests 라이브러리를 사용하여 JIRA REST API를 호출하고, 이슈 생성, 조회 등의 작업을 수행하는 방법을 설명합니다.

1. 필수 라이브러리 설치

먼저, JIRA API와 상호작용하기 위해 requests 라이브러리를 설치해야 합니다.

pip install requests

2. JIRA API 인증

JIRA API를 사용하려면 인증이 필요합니다. 일반적으로 다음 두 가지 방법으로 인증할 수 있습니다: - Basic Authentication: 사용자 이름과 API 토큰을 사용하여 인증. - OAuth: OAuth 프로토콜을 사용한 인증.

이번 글에서는 Basic Authentication 방식을 사용해 API에 접근하는 방법을 설명합니다.

3. JIRA API Token 생성

JIRA에서 API 요청을 보내기 위해서는 API 토큰이 필요합니다. API 토큰은 다음 과정을 통해 생성할 수 있습니다. 1. JIRA에 로그인. 2. 오른쪽 상단의 프로필 아이콘을 클릭하고, “Account Settings” 선택. 3. “Security” 탭에서 “Create and manage API tokens”를 선택한 후 “Create API token”을 클릭해 토큰을 생성.

이제 API 토큰을 복사해서 사용합니다.

Python으로 JIRA 명령 수행하기

requests 라이브러리를 사용해 JIRA API와 상호작용하는 방법을 예제와 함께 설명하겠습니다.

1. JIRA 이슈 조회 (GET 요청)

JIRA 이슈를 조회하기 위해 GET 요청을 사용합니다. 특정 이슈를 조회하는 API 엔드포인트는 다음과 같습니다.

https://your-domain.atlassian.net/rest/api/3/issue/{issueIdOrKey}

Python에서 이 API를 호출하는 코드는 다음과 같습니다.

import requests
from requests.auth import HTTPBasicAuth

# JIRA 설정
JIRA_URL = "https://your-domain.atlassian.net"
ISSUE_KEY = "PROJ-1"  # 조회할 이슈 키
API_ENDPOINT = f"{JIRA_URL}/rest/api/3/issue/{ISSUE_KEY}"

# 인증 정보 (이메일과 API 토큰)
auth = HTTPBasicAuth("your-email@example.com", "your-api-token")

# 헤더
headers = {
    "Accept": "application/json"
}

# GET 요청
response = requests.get(API_ENDPOINT, headers=headers, auth=auth)

# 응답 처리
if response.status_code == 200:
    issue_data = response.json()
    print(issue_data)  # 이슈 정보를 JSON으로 출력
else:
    print(f"Failed to fetch issue: {response.status_code}")

2. JIRA 이슈 생성 (POST 요청)

JIRA에서 새 이슈를 생성하기 위해 POST 요청을 사용합니다. 이슈 생성을 위한 API 엔드포인트는 다음과 같습니다.

https://your-domain.atlassian.net/rest/api/3/issue

Python에서 이슈를 생성하는 코드는 다음과 같습니다.

import requests
from requests.auth import HTTPBasicAuth
import json

# JIRA 설정
JIRA_URL = "https://your-domain.atlassian.net"
API_ENDPOINT = f"{JIRA_URL}/rest/api/3/issue"

# 인증 정보 (이메일과 API 토큰)
auth = HTTPBasicAuth("your-email@example.com", "your-api-token")

# 헤더
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

# 이슈 생성에 필요한 데이터 (프로젝트 키, 요약, 이슈 타입 등)
issue_data = {
    "fields": {
        "project": {
            "key": "PROJ"
        },
        "summary": "New Issue from API",
        "description": "Creating an issue using the REST API",
        "issuetype": {
            "name": "Task"
        }
    }
}

# POST 요청
response = requests.post(API_ENDPOINT, headers=headers, auth=auth, data=json.dumps(issue_data))

# 응답 처리
if response.status_code == 201:
    issue = response.json()
    print(f"Issue created successfully with ID: {issue['key']}")
else:
    print(f"Failed to create issue: {response.status_code}")
    print(response.text)

3. JIRA 이슈 업데이트 (PUT 요청)

기존 이슈를 업데이트하려면 PUT 요청을 사용합니다. 이슈 업데이트를 위한 엔드포인트는 이슈 조회와 동일하며, HTTP 메서드만 변경됩니다.

import requests
from requests.auth import HTTPBasicAuth
import json

# JIRA 설정
JIRA_URL = "https://your-domain.atlassian.net"
ISSUE_KEY = "PROJ-1"  # 업데이트할 이슈 키
API_ENDPOINT = f"{JIRA_URL}/rest/api/3/issue/{ISSUE_KEY}"

# 인증 정보 (이메일과 API 토큰)
auth = HTTPBasicAuth("your-email@example.com", "your-api-token")

# 헤더
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

# 업데이트할 데이터
update_data = {
    "fields": {
        "summary": "Updated summary",
        "description": "Updated description via API"
    }
}

# PUT 요청
response = requests.put(API_ENDPOINT, headers=headers, auth=auth, data=json.dumps(update_data))

# 응답 처리
if response.status_code == 204:
    print(f"Issue {ISSUE_KEY} updated successfully.")
else:
    print(f"Failed to update issue: {response.status_code}")
    print(response.text)

4. JIRA 이슈 삭제 (DELETE 요청)

이슈를 삭제하기 위해 DELETE 요청을 사용할 수 있습니다. 이슈 삭제를 위한 엔드포인트는 이슈 조회와 동일합니다.

import requests
from requests.auth import HTTPBasicAuth

# JIRA 설정
JIRA_URL = "https://your-domain.atlassian.net"
ISSUE_KEY = "PROJ-1"  # 삭제할 이슈 키
API_ENDPOINT = f"{JIRA_URL}/rest/api/3/issue/{ISSUE_KEY}"

# 인증 정보 (이메일과 API 토큰)
auth = HTTPBasicAuth("your-email@example.com", "your-api-token")

# DELETE 요청
response = requests.delete(API_ENDPOINT, auth=auth)

# 응답 처리
if response.status_code == 204:
    print(f"Issue {ISSUE_KEY} deleted successfully.")
else:
    print(f"Failed to delete issue: {response.status_code}")

JIRA API 사용 시 주의사항

  1. API 요청 제한 JIRA API는 요청에 제한이 있습니다. 일반적으로 초당 일정량의 요청만 허용하므로, 많은 요청을 할 경우 API 제한에 걸릴 수 있습니다. 제한에 걸릴 경우 잠시 기다렸다가 재시도해야 합니다.

  2. JIRA 권한 설정 API를 통해 이슈를 생성, 업데이트 또는 삭제하려면 해당 작업에 대한 권한이 필요합니다. 관리자나 적절한 역할을 가진 사용자만이 이러한 작업을 수행할 수 있으니, 적절한 권한이 설정되어 있는지 확인하세요.

  3. JIRA 필드 이슈를 생성하거나 업데이트할 때 필요한 필드(예: 프로젝트 키, 이슈 타입, 우선순위 등)는 JIRA의 설정에 따라 다를 수 있습니다. API 호출 전에 JIRA의 필드 구성을 미리 확인해야 합니다.

요약

JIRA REST API는 프로젝트 관리 및 이슈 트래킹을 자동화하고, Python의 requests 라이브러리를 사용해 쉽게 상호작용할 수 있습니다. GET, POST, PUT, DELETE 요청을 통해 JIRA 이슈를 조회, 생성, 업데이트, 삭제하는 다양한 작업을 수행할 수 있으며, 이 글에서는 각각의 작업을 수행하는 코드 예제를 살펴보았습니다. JIRA API를 통해 프로젝트를 효율적으로 관리하고, 반복적인 작업을 자동화해 업무 생산성을 높일 수 있습니다.