Microsoft MVP성태의 닷넷 이야기
.NET Framework: 780. C# - JIRA REST API 사용 정리 [링크 복사], [링크+제목 복사]
조회: 5360
글쓴 사람
홈페이지
첨부 파일

C# - JIRA REST API 사용 정리

JIRA REST API를 사용하는 방법을 간단하게 정리해 봅니다. ^^ 문서는 이미 다음과 같이 잘 공개되어 있습니다.

Jira REST API examples
; https://developer.atlassian.com/server/jira/platform/jira-rest-api-examples/

사용할 수 있는 API 종류는 다음의 경로에서 찾을 수 있습니다.

Index of ./software/jira/docs/api/REST
; https://docs.atlassian.com/software/jira/docs/api/REST/

가령, 여러분들의 회사에 설치된 JIRA 시스템의 버전이 6.1.4라면 다음과 같이 지원 API 문서를 볼 수 있습니다.

JIRA 6.1.4 REST API documentation
; https://docs.atlassian.com/software/jira/docs/api/REST/6.1.4/

이 글에서는 (제 환경이 ^^; 6.1.4 버전이므로) 위의 문서를 대상으로 진행합니다.)




자, 그럼 쿼리를 날려 볼까요? ^^ 예를 들어 다음과 같은 조건에서,

계정: testuser
암호: pass@word
JIRA 서버: jira.test.com

JIRA에 자신에게 할당된 이슈를 확인하는 요청을 (Windows 10에서도 제공하는) curl을 이용해 다음과 같이 확인할 수 있습니다.

[특정 사용자에게 할당된 Issue를 검색하는 쿼리: search]

curl -u [JIRA계정]:[암호] -X GET -H "Content-Type: application/json" http://[JIRA 서버]/rest/api/latest/search?jql=assignee=[사용자]

여기에 -v 옵션을 더하면 요청 및 응답 헤더를 함께 출력으로 보여주기 때문에 C# 코드로 어떻게 인증해야 하는지를 알 수 있습니다.

curl -v -u testuser:pass@word -X GET -H "Content-Type: application/json" http://jira.test.com/rest/api/latest/search?jql=assignee=testuser

위와 같이 실행하면 요청 및 응답 헤더가 다음과 같은 식으로 출력됩니다.

C:\>curl -v -u testuser:pass@word -X GET -H "Content-Type: application/json" http://jira.test.com/rest/api/latest/search?jql=assignee=testuser
Note: Unnecessary use of -X or --request, GET is already inferred.
*   Trying 192.168.100.50...
* TCP_NODELAY set
* Connected to jira.test.com (192.168.100.50) port 80 (#0)
* Server auth using Basic with user 'testuser'
> GET /rest/api/latest/search?jql=assignee=testuser HTTP/1.1
> Host: jira.test.com
> Authorization: Basic dGVzdHVzZXI6cGFzc0B3b3Jk
> User-Agent: curl/7.55.1
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 200 OK
< Date: Thu, 28 Jun 2018 00:27:30 GMT
< Server: Apache/2.2.17 (Unix) mod_jk/1.2.31
< X-AREQUESTID: 567x639827x1
< Set-Cookie: JSESSIONID=FA156...[생략]...FD0FA; Path=/; HttpOnly
< X-Seraph-LoginReason: OK
< Set-Cookie: atlassian.xsrf.token=A7M3-BI7E-1YXF-MHP5|3c5ba...[생략]...07747|lin; Path=/
< X-ASESSIONID: 9pof4z
< X-AUSERNAME: testuser
< Cache-Control: no-cache, no-store, no-transform
< Transfer-Encoding: chunked
< Content-Type: application/json;charset=UTF-8
<
...[내용 생략]...

아하... Basic 인증 방식을 사용하고 있고, 응답으로 JSESSIONID, atlassian.xsrf.token을 Cookie로 내려주고 있습니다. 자, 그럼 2가지 방식으로 JIRA REST API를 호출할 수 있습니다.

  1. 인증을 위한 REST API를 호출 후, 이후의 요청은 JSESSIONID, atlassian.xsrf.token을 전달
  2. 모든 인증마다 BASIC 인증 헤더를 전달

이 글에서는 1번 방식을 사용할 텐데요, 그런데 딱히 REST API에 대한 로그인 전용 쿼리가 없으므로 이를 대신할 적당한 API 후보를 찾아야 합니다. 문서를 보니, /rest/api/2/myself 정도가 적당한 것 같습니다. 따라서, 우리 나름대로 Login API를 다음과 같이 만들 수 있습니다.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleApp1
{
    class Jira
    {
        const string QUERY_URL_FORMAT = "http://{0}/rest/api/latest/{1}";
        string _baseUrl;
        CookieContainer _cookies;
        HttpClient _httpClient;

        public async Task<bool> Login(string jiraServer, string userId, string password)
        {
            string url = string.Format(QUERY_URL_FORMAT, jiraServer, "myself");
            string authHeader = CreateBasicAuth(userId, password);

            HttpClientHandler handler = new HttpClientHandler();
            _cookies = new CookieContainer();
            handler.CookieContainer = _cookies;

            HttpClient hc = new HttpClient(handler);

            hc.DefaultRequestHeaders.Add("Authorization", authHeader);

            HttpResponseMessage hrm = await hc.GetAsync(url);
            if (hrm.StatusCode == System.Net.HttpStatusCode.Unauthorized)
            {
                return false;
            }

            _baseUrl = string.Format(QUERY_URL_FORMAT, jiraServer, "");
            _httpClient = hc;

            return true;
        }

        private string CreateBasicAuth(string userId, string password)
        {
            string text = userId + ":" + password;
            byte[] buf = Encoding.UTF8.GetBytes(text);
            return "Basic " + Convert.ToBase64String(buf);
        }
    }
}

사용은 이렇게 해주면 됩니다.

static async Task Main(string[] args)
{
    (string id, string password) = ("testuser", "pass@word");
    string jiraServer = "jira.test.com";

    Jira jira = new Jira();

    if (await jira.Login(jiraServer, id, password) == false)
    {
        Console.WriteLine("Auth failed: " + id);
        return;
    }

    Console.WriteLine("Connected");
}

자, 그럼 이제 개별 REST API를 C#으로 래핑하는 작업을 하나씩 해주시면 됩니다. 가령, 해당 사용자에게 할당된 모든 이슈를 가져오고 싶다면 6.1.4 버전의 API 문서에 따라, /rest/api/2/search API를 다음과 같이 추가할 수 있습니다.

...[생략]...

namespace ConsoleApp1
{
    class Jira
    {
        // ...[생략]...

        public async Task<string> GetIssuesByAssignee(string projectKey, string assignee)
        {
            string url = _baseUrl + "search?jql=assignee=" + assignee + " and project=" + projectKey;

            HttpResponseMessage hrm = await _httpClient.GetAsync(url);

            string result = await hrm.Content.ReadAsStringAsync();
            return result;
        }
    }
}

사용법은 다음과 같이 해주면 되겠고.

static async Task Main(string[] args)
{
    (string id, string password) = ("testuser", "pass@word");
    string jiraServer = "jira.test.com";

    Jira jira = new Jira();

    if (await jira.Login(jiraServer, id, password) == false)
    {
        Console.WriteLine("Auth failed: " + id);
        return;
    }

    string result = await jira.GetIssuesByAssignee("myProject", id);
    Console.WriteLine(result);
}

이후 원하는 만큼 API 호출을 추가하면 됩니다.




API 호출에서 한 가지 아쉬운 점이 있다면 문자열 반환입니다. 이 부분을 좀 더 멋있게 역직렬화하면 좋을 듯한데요. GetIssuesByAssignee 메서드의 결과물을 보면,

{"expand":"schema,names","startAt":0,"maxResults":50,"total":358,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations",...[생략]...,"versions":[],"environment":null,"timeestimate":null,"customfield_10300":null,"aggregateprogress":{"progress":0,"total":0},"lastViewed":null,"timeoriginalestimate":null,"aggregatetimespent":null}}]}

너무 복잡하므로 이것을 그대로 json 확장자의 파일로 저장해 Visual Studio에서 열고 마우스 우클릭으로 "Format Document" 메뉴를 실행하면 다음과 같이 깔끔하게 포맷팅이 됩니다.

jira_rest_api_1.png

이것을 보고 C# POCO 타입들을 만들어 나갈 수 있습니다. 하지만... 언제 저걸 다 작성하겠습니까? 그냥 다음의 사이트를 방문해서,

json2csharp
; http://json2csharp.com/

위의 json 텍스트를 붙여 넣고 "Generate" 버튼을 누르면 C# 타입들이 자동으로 생성됩니다. ^^ 이것을 프로젝트에 추가하고, 단지 "RootObject" 타입의 이름만 "SearchResult"로 바꾸겠습니다.

자... 그럼 이제 Newtonsoft.Json을 이용해,

Install-Package Newtonsoft.Json -Version 11.0.2 

다음과 같이 역직렬화한 클래스를 반환할 수 있게 되었고,

public async Task<SearchResult> GetIssuesByAssignee(string projectKey, string assignee)
{
    string url = _baseUrl + "search?jql=assignee=" + assignee + " and project=" + projectKey;

    HttpResponseMessage hrm = await _httpClient.GetAsync(url);

    string text = await hrm.Content.ReadAsStringAsync();

    SearchResult result = Newtonsoft.Json.JsonConvert.DeserializeObject<SearchResult>(text);
    return result;
}

형식 안정성을 기반으로 한 인텔리센스의 도움으로 좀 더 편리하게 코딩을 할 수 있습니다.

SearchResult result = await jira.GetIssuesByAssignee(projectKey, assignee);

foreach (var issue in result.issues)
{
    Console.WriteLine(issue.key);
}

이 정도면... 대충 설명이 끝난 것 같군요. ^^

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




물론 소스 코드가 공개되어 있는,

jonas0007/Jira.SDK 
; https://github.com/jonas0007/Jira.SDK

라이브러리를 NuGet으로부터 다운로드해,

Jira.SDK 
; https://www.nuget.org/packages/Jira.SDK/

Install-Package Jira.SDK -Version 1.2.25 

다음과 같이 편안하세 사용하셔도 좋습니다. ^^

// https://github.com/jonas0007/Jira.SDK

Jira jira = new Jira();
//Connect to Jira with username and password. Please be aware that the information returned by the Jira REST API depends on the access rigths of the user.
jira.Connect("{{JIRA URL}}", "{{USERNAME}}", "{{PASSWORD}}");

//You can also connect to Jira anonymously. Please make sure that the information you want to request with the SDK is accessible by unauthenticated users.
jira.Connect("{{JIRA URL}}");

//Gets all of the projects configured in your jira instance
List<Project> projects = jira.GetProjects();

//Gets a specific project by name
Project project = jira.GetProject("{{projectname}}");
            
//Gets all of users favourite filters
List<IssueFilter> filters = jira.GetFilters();

//Gets a specific filter by name
IssueFilter filter = jira.GetFilter("{{filtername}}");

//Get a list of agile boards configured in your jira instance
List<AgileBoard> agilaboards = jira.GetAgileBoards();

//Get a specific issue with key
Issue issue = jira.GetIssue("{{issuekey}}");

//Add a new issue to a project
Project project = jira.GetProject("{{projectname}}");
Issue newIssue = project.AddIssue(new IssueFields()
{
                Summary = "Summary of the new issue",
                IssueType = new IssueType(0, "Type"),
                CustomFields = new Dictionary<string, CustomField>() {
                    { "customfield_11000", new CustomField(11000, "Value") }
                }
            });
);




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]





[최초 등록일: ]
[최종 수정일: 6/28/2018 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer@outlook.com

비밀번호

댓글 쓴 사람
 



2020-04-09 08시26분
[안녕하세요.] (string projectKey, string newVersionName, string versionDesc, string releaseDate) = FromArgs(args);

공유해주신 코드에서 윗 부분을 받아오지 못하던데 혹시 확인부탁드려도 될까요?ㅠㅠ
[손님]
2020-04-09 09시13분
그건 그냥 무시하시고, 자신의 상황에 맞게 projectKey, version, desc, release date를 설정하시면 됩니다. 저는 그냥 그걸 명령행에서 받아오게 코딩한 것에 불과합니다.
정성태
2020-04-09 02시12분
[안녕하세요.] 헉 감사합니다! 혹시... jira & C# 개발쪽을 어쩌다보니 맡게됐는데 수업 좀 요청드려도될까요?? 원격으로... 수강료 당연히 내겠숩니다.
[손님]
2020-04-09 03시42분
사실 딱히 강의할 만한 자료는 위의 글이 전부입니다. 그냥 이곳에 질문으로 하셔도 충분하지 않을까 싶은데요. ^^
정성태

... [16]  17  18  19  20  21  22  23  24  25  26  27  28  29  30  ...
NoWriterDateCnt.TitleFile(s)
11907정성태6/4/20191043오류 유형: 541. msbuild - MSB4024 The imported project file "...targets" could not be loaded
11906정성태5/21/2019890.NET Framework: 835. .NET Core/C# - 리눅스 syslog에 로그 남기는 방법
11905정성태5/21/20191278.NET Framework: 834. C# - 폴더 경로 문자열에서 "..", "." 표기를 고려한 최종 문자열을 얻는 방법 - 두 번째 이야기
11904정성태5/21/20192642.NET Framework: 833. C# - Open Hardware Monitor를 이용한 CPU 온도 정보파일 다운로드1
11903정성태5/21/20191439오류 유형: 540. .NET Core - System.PlatformNotSupportedException: The named version of this synchronization primitive is not supported on this platform.
11902정성태5/21/2019967오류 유형: 539. mstest 실행 시 "The directory name is invalid." 오류 발생
11901정성태5/21/20191632오류 유형: 538. msbuild 오류 - Could not find a part of the path '%LOCALAPPDATA%\Temp\2\.NETFramework,Version=v4.0.AssemblyAttributes.cs'
11900정성태3/12/20201547오류 유형: 537. "sfc /scannow" 실행 중 시스템이 부팅되는 현상
11899정성태5/17/20191643Linux: 9. Linux에서 윈도우의 OutputDebugString 대신 사용할 수 있는 syslog [1]
11898정성태5/20/20191718VC++: 130. C++ string의 c_str과 data 함수의 차이점 [3]
11897정성태5/16/20193154오류 유형: 536. Visual Studio - "Developer Pack"을 설치했는데도 "대상 프레임워크" 목록에 나오지 않는 경우 [1]
11896정성태5/15/20192418개발 환경 구성: 440. C#, C++ - double의 Infinity, NaN 표현 방식파일 다운로드1
11895정성태5/12/20191641.NET Framework: 832. ML.NET Model Builder - 회귀(Regression), 다중 분류(Multi-class classification) 예제파일 다운로드1
11894정성태5/12/20192259VS.NET IDE: 135. Visual Studio - ML.NET Model Builder 소개 [1]
11893정성태5/10/20191753오류 유형: 535. C# 6.0 이상의 문법을 컴파일 시 오류가 발생한다면?
11892정성태5/10/20191160웹: 38. HTTP Cookie의 expires 시간 형식(RFC7231)
11891정성태5/9/20191485.NET Framework: 831. (번역글) .NET Internals Cookbook Part 12 - Memory structure, attributes, handles
11890정성태5/8/20191168개발 환경 구성: 439. "Visual Studio Enterprise is required to execute the test." 메시지와 관련된 코드 기록
11889정성태5/8/20191307개발 환경 구성: 438. mstest, QTAgent의 로그 파일 설정 방법
11888정성태5/8/20192662.NET Framework: 830. C# - 비동기 호출을 취소하는 CancellationToken의 간단한 예제 코드파일 다운로드1
11887정성태5/8/20191679.NET Framework: 829. C# - yield 문을 사용할 수 있는 메서드의 조건
11886정성태5/8/20191662오류 유형: 534. mstest.exe 실행 시 "Visual Studio Enterprise is required to execute the test." 오류 [2]
11885정성태5/7/20191065오류 유형: 533. mstest.exe 실행 시 "File extension specified '.loadtest' is not a valid test extension." 오류 발생
11884정성태5/5/20191944.NET Framework: 828. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 두 번째 이야기
11883정성태5/3/20192415.NET Framework: 827. C# - 인터넷 시간 서버로부터 받은 시간을 윈도우에 적용하는 방법파일 다운로드1
11882정성태5/9/20191297.NET Framework: 826. (번역글) .NET Internals Cookbook Part 11 - Various C# riddles파일 다운로드1
... [16]  17  18  19  20  21  22  23  24  25  26  27  28  29  30  ...