[.Net] C# 레드마인 REST API 사용하는 방법(예제 포함)

Redmine REST API

REST API란 HTTP 프로토콜을 활용하여 데이터를 주고받는 것을 의미하죠. REST API에 대한 좀 더 자세한 내용은 아래 링크를 참고하시면 이해하는데 도움이 됩니다.

[.Net] C#에서 Open API 고속도로 교통량 정보 얻기 (예제 포함)

 

[.Net] C#에서 Open API 고속도로 교통량 정보 얻기 (예제 포함)

소개 저는 머신 비전 분야에 근무하고 있고, 주로 비전 관련 프로그램을 개발하고 있습니다. 사실 매일 하던 것만 개발하다 보니 지루하기도 하고, 개발의 방향성이 너무 폭이 좁은 느낌이 들었

luckygg.tistory.com

그런데 레드마인도 REST API를 통해 데이터에 접근할 수 있으며, API는 XML 및 JSON 형식 모두 지원합니다. 그럼 어떤 데이터에 접근할 수 있는지 알아보겠습니다.

Redmine REST API 목록

REST API로 접근 가능한 항목과 현재 제공되는 API의 개발 상태는 아래 표와 같습니다.

각 항목 별 상태의 의미는 다음과 같습니다. Stable이 단어 그대로 가장 안정적이라는 의미이죠.

REST API를 사용하기 위한 준비 단계

1. REST 웹 서비스 활성화하기

Redmine REST API를 사용하려면 API 활성화 설정이 필요합니다. 관리자 계정으로 로그인한 후 관리의 설정 메뉴를 들어갑니다. 그리고 아래의 화면에서 REST 웹 서비스 활성화 버튼을 체크하고 저장합니다.

2. API 접근키 확인하기

로그인 한 상태에서 내 계정(My account) 메뉴를 클릭합니다. 그리고 좌측의 API 접근키를 확인합니다.

나중에 이 키를 사용하여 레드마인 API에 접근할 수 있습니다.

C#에서 Redmine REST API 접근하기

ExamRedmineApi 이름으로 Windows Forms 앱 프로젝트를 생성합니다.

NuGet에서 redmine 을 검색하고 redmine-api를 선택하여 설치합니다. 만약, NuGet에서 제공하는 redmine api를 사용하길 원치 않다면 직접 REST API를 제어하면 됩니다. 본문에서는 쉽게 사용하기 위해 NuGet을 사용합니다.

Form UI는 다음과 같이 버튼과 리스트 뷰를 배치했습니다.

코드는 다음과 같이 작성합니다.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using Redmine.Net.Api;
using Redmine.Net.Api.Types;
using System.Collections.Specialized;
 
namespace ExamRedmineApi
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
 
        private void buttonRefresh_Click(object sender, EventArgs e)
        {
            try
            {
                //조회할 레드마인 프로젝트의 메인 주소
                string host = "";
                //API 키
                string apiKey = "";
                var manager = new RedmineManager(host, apiKey);
                //일감 상태가 닫혀있는 것만
                var parameters = new NameValueCollection { { RedmineKeys.STATUS_ID, "closed" } };
                //2022-01-1~2022-02-01 사이 조건
                parameters.Add(RedmineKeys.CREATED_ON, "><2022-01-01|2022-02-01");
                //일감 목록 받기
                var issues = manager.GetObjects<Issue>(parameters);
                foreach(var issue in issues)
                {
                    ListViewItem item = new ListViewItem();
                    item.Text = issue.Id.ToString();
                    item.SubItems.Add(issue.Author.Name);
                    item.SubItems.Add(issue.Subject.ToString());
 
                    listViewIssues.Items.Add(item);
                }
            }
            catch(Exception exc)
            {
                MessageBox.Show(exc.Message);
            } 
        }
    }
}

코드가 아주 간단하죠? 실제 동작 결과는 다음과 같습니다.

parameters에 여러 조건을 추가하여 필터링된 자료를 조회할 수 있습니다. NuGet Redmine API에 관한 사용 방법은 아래 링크를 참고하세요.

https://github.com/zapadi/redmine-net-api/wiki

 

GitHub - zapadi/redmine-net-api: .Net API for Redmine bug/task management systems.

.Net API for Redmine bug/task management systems. Contribute to zapadi/redmine-net-api development by creating an account on GitHub.

github.com

아래의 샘플 코드도 참고하세요.

ExamRedmineApi.zip

5.33MB