Microsoft MVP성태의 닷넷 이야기
.NET Framework: 793. C# - REST API를 이용해 NuGet 저장소 제어 [링크 복사], [링크+제목 복사]
조회: 1721
글쓴 사람
홈페이지
첨부 파일

C# - REST API를 이용해 NuGet 저장소 제어

NuGet 저장소의 REST API는 다음의 공식 문서에서 자세하게 설명하고 있습니다.

NuGet API
; https://docs.microsoft.com/en-us/nuget/api/overview

물론 다음과 같은 잘 정리된 라이브러리를 이용해 제어하는 것도 가능하지만,

NuGet.Protocol
; https://www.nuget.org/packages/NuGet.Protocol/4.8.0

이 글에서는 그냥 HTTP 통신으로 만들어 보겠습니다. ^^




우선, 시작점은 다음의 JSON 결과물로부터 출발합니다.

https://api.nuget.org/v3/index.json

[index.json 파일 내용]

{
  "version": "3.0.0",
  "resources": [
    {
      "@id": "https://api-v2v3search-0.nuget.org/query",
      "@type": "SearchQueryService",
      "comment": "Query endpoint of NuGet Search service (primary)"
    },
    {
      "@id": "https://api-v2v3search-1.nuget.org/query",
      "@type": "SearchQueryService",
      "comment": "Query endpoint of NuGet Search service (secondary)"
    },

    ...[생략]...

    {
      "@id": "https://api.nuget.org/v3/registration3-gz-semver2/",
      "@type": "RegistrationsBaseUrl/Versioned",
      "clientVersion": "4.3.0-alpha",
      "comment": "Base URL of Azure storage where NuGet package registration info is stored in GZIP format. This base URL includes SemVer 2.0.0 packages."
    },
    {
      "@id": "https://api.nuget.org/v3/catalog0/index.json",
      "@type": "Catalog/3.0.0",
      "comment": "Index of the NuGet package catalog."
    }
  ],
  "@context": {
    "@vocab": "http://schema.nuget.org/services#",
    "comment": "http://www.w3.org/2000/01/rdf-schema#comment"
  }
}

보는 바와 같이 "@type"에 해당하는 기능을 "@id"에서 제공하는 링크를 통해 서비스를 제공합니다. 따라서, 다음과 같은 코드로 시작할 수 있습니다.

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

namespace NugetRestClient
{
    class NugetClient
    {
        const string _sourceUrl = "https://api.nuget.org/v3/index.json";
        CookieContainer _cookies;
        HttpClient _httpClient;
        ServiceIndex _serviceIndex;

        private string GetServiceEndPoint(string serviceTypeName)
        {
            foreach (var item in _serviceIndex.resources)
            {
                if (item.type == serviceTypeName)
                {
                    return item.id;
                }
            }

            throw new ApplicationException("ServiceNotFound: " + serviceTypeName);
        }

        public NugetClient()
        {
            HttpClientHandler handler = new HttpClientHandler();
            _cookies = new CookieContainer();
            handler.CookieContainer = _cookies;

            HttpClient hc = new HttpClient(handler);
            _httpClient = hc;
        }

        public async Task GetFeedAsync()
        {
            string text = await _httpClient.GetStringAsync(_sourceUrl);
            _serviceIndex = Newtonsoft.Json.JsonConvert.DeserializeObject<ServiceIndex>(text);
        }
    }
}

위의 코드를 이용해 다음과 같이 service index 정보를 가져옵니다.

public static async Task<int> Main(string[] args)
{
    NugetClient client = new NugetClient();
    await client.GetFeedAsync();

    return 0;
}

이제 NuGet으로부터 등록된 패키지의 정보를 다음과 같은 식으로 처리할 수 있습니다.

public async Task<SearchQueryServiceResult> GetPackageInfoAsync(string packageId, bool includePrerelease)
{
    string url = GetServiceEndPoint("SearchQueryService");
    string query = string.Format("{0}?q={1}", url, packageId);

    if (includePrerelease == true)
    {
        query += "&prerelease=true";
    }

    string text = await _httpClient.GetStringAsync(query);
    return Newtonsoft.Json.JsonConvert.DeserializeObject<SearchQueryServiceResult>(text);
}

위의 query 변수는 index.json에 정의된 SearchQueryService 서비스의 url에 대해 다음과 같은 쿼리를,

{servicequery}?q={packageId}

{servicequery}?q={packageId}&prerelease=true

NuGet에 전송합니다. Search와 관련해 어떤 유형의 서비스들이 있는지는 문서에 잘 나와 있습니다.

Docs / NuGet / API - Search
; https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource

위의 문서에 보면, @type으로 다음의 값들이 가능하다고 나옵니다.

SearchQueryService : The initial release
SearchQueryService/3.0.0-beta : Alias of SearchQueryService
SearchQueryService/3.0.0-rc : Alias of SearchQueryService

현재(2018-09-18) 기준으로 정식 서비스는 "SearchQueryService"이므로 이 글에서는 그 옵션을 사용한 것입니다. 이와 함께 query에 전달할 수 있는 인자들을 다음과 같이 소개하고 있습니다.

GET {@id}?q={QUERY}&skip={SKIP}&take={TAKE}&prerelease={PRERELEASE}&semVerLevel={SEMVERLEVEL}

보면 페이징 기능도 있으므로 적절하게 사용하시면 됩니다.




예제 시나리오를 하나 작성해서 구현해 보겠습니다. ^^

빌드 시스템을 통해 생성된 바이너리를 NuGet 패키지의 새 버전에 등록할 때마다 alpha, alpha2, alpha3, alpha4, ...와 같은 식으로 버전을 늘려 가며 등록하는 것입니다. 정식 릴리스는 아니므로 기존 alpha(N) 버전이 있다면 unlist로 만들고 다음 릴리스 번호 값을 구하는 정도까지만 구현해 보겠습니다.

이를 위해서는 다음의 2개 메서드를 추가 구현하면 됩니다.

public async Task<PackageMetadata> GetPackageMetadataAsync(string packageId, string vesrionPostfix)
{
    string url = GetServiceEndPoint("RegistrationsBaseUrl");
    string query = string.Format("{0}{1}/{2}.json", url, packageId.ToLower(), vesrionPostfix);

    HttpResponseMessage hrm = await _httpClient.GetAsync(query);

    if (hrm.StatusCode == HttpStatusCode.NotFound)
    {
        return null;
    }

    string text = await hrm.Content.ReadAsStringAsync();
    PackageMetadata searchResult = Newtonsoft.Json.JsonConvert.DeserializeObject<PackageMetadata>(text);
    return searchResult;
}

public async Task<bool> UnlistVersionPackageAsync(string packageId, string vesrionPostfix)
{
    string url = GetServiceEndPoint("PackagePublish/2.0.0");
    string query = string.Format("{0}/{1}/{2}", url, packageId.ToLower(), vesrionPostfix);

    HttpResponseMessage hrm = await _httpClient.DeleteAsync(query);
    return hrm.StatusCode == HttpStatusCode.OK;
}

주의할 것은, 등록된 패키지의 특정 버전 상태(Status)를 "Unlisted"로 바꾸기 위해서는 API Key를 HTTP 요청의 "X-NuGet-ApiKey" 헤더에 전송해야 합니다. 이 작업은 HttpClient를 생성할 때 미리 해주는 것으로 처리하면 편리합니다.

public NugetClient(string apiKey = "")
{
    HttpClientHandler handler = new HttpClientHandler();
    _cookies = new CookieContainer();
    handler.CookieContainer = _cookies;

    HttpClient hc = new HttpClient(handler);
    _httpClient = hc;

    if (string.IsNullOrEmpty(apiKey) == false)
    {
        _httpClient.DefaultRequestHeaders.Add("X-NuGet-ApiKey", apiKey);
    }
}

래퍼 API가 만들어졌으니 이제 다음과 같이 사용할 수 있습니다.

string packageId = "MyTestPackage";
string versionPrefix = "1.0.0.0";
string checkPostfix = versionPrefix + "-alpha";
int alphaNumber = 1;

while (true)
{
    PackageMetadata item = await client.GetPackageMetadataAsync(packageId, checkPostfix);
    if (item == null)
    {
        break;
    }

    if (item.listed == true)
    {
        await client.UnlistVersionPackageAsync(packageId, checkPostfix);
    }

    alphaNumber++;
    checkPostfix = $"{versionPrefix}-alpha{alphaNumber}";
}

Console.WriteLine("Next candidate version: " + checkPostfix);

이 정도면 제법 감각을 익히셨을 테니 여러분이 필요한 나머지 기능들도 쉽게 구현할 수 있을 것입니다. ^^

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




참고로, NuGet.exe 프로그램에 대한 배포 목록도 다음의 json 파일로 구할 수 있습니다.

https://dist.nuget.org/tools.json
https://dist.nuget.org/tools.schema.json




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

[연관 글]





[최초 등록일: ]
[최종 수정일: 9/19/2018 ]

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

비밀번호

댓글 쓴 사람
 




1  2  3  4  5  6  7  8  9  10  11  12  [13]  14  15  ...
NoWriterDateCnt.TitleFile(s)
11849정성태3/18/20191439.NET Framework: 812. pscp.exe 기능을 C#으로 제어하는 방법파일 다운로드1
11848정성태3/17/2019893스크립트: 14. 윈도우 CMD - 파일이 변경된 경우 파일명을 변경해 복사하고 싶다면?
11847정성태3/17/20191479Linux: 7. 리눅스 C/C++ - 공유 라이브러리 동적 로딩 후 export 함수 사용 방법파일 다운로드1
11846정성태3/15/20191379Linux: 6. getenv, setenv가 언어/운영체제마다 호환이 안 되는 문제
11845정성태3/15/20191803Linux: 5. Linux 응용 프로그램의 (C++) so 의존성 줄이기(ReleaseMinDependency) [3]
11844정성태5/22/20191754개발 환경 구성: 434. Visual Studio 2019 - 리눅스 프로젝트를 이용한 공유/실행(so/out) 프로그램 개발 환경 설정 [1]파일 다운로드1
11843정성태3/14/2019972기타: 75. MSDN 웹 사이트를 기본으로 영문 페이지로 열고 싶다면?
11842정성태5/3/20191019개발 환경 구성: 433. 마이크로소프트의 CoreCLR 프로파일러 예제를 Visual Studio CMake로 빌드하는 방법 [1]파일 다운로드1
11841정성태3/13/2019814VS.NET IDE: 132. Visual Studio 2019 - CMake의 컴파일러를 기본 g++에서 clang++로 변경
11840정성태3/13/2019860오류 유형: 526. 윈도우 10 Ubuntu App 환경에서는 USB 외장 하드 접근 불가
11839정성태3/12/20191315디버깅 기술: 124. .NET Core 웹 앱을 호스팅하는 Azure App Services의 프로세스 메모리 덤프 및 windbg 분석 개요 [2]
11838정성태5/9/20191960.NET Framework: 811. (번역글) .NET Internals Cookbook Part 1 - Exceptions, filters and corrupted processes [1]파일 다운로드1
11837정성태10/14/20196472기타: 74. 도서: 시작하세요! C# 7.3 프로그래밍 [10]
11836정성태10/12/20191453오류 유형: 525. Visual Studio 2019 Preview 4/RC - C# 8.0 Missing compiler required member 'System.Range..ctor' [1]
11835정성태3/5/20191541.NET Framework: 810. C# 8.0의 Index/Range 연산자를 .NET Framework에서 사용하는 방법 및 비동기 스트림의 컴파일 방법 [1]파일 다운로드1
11834정성태3/4/20191095개발 환경 구성: 432. Visual Studio 없이 최신 C# (8.0) 컴파일러를 사용하는 방법
11833정성태5/14/20191332개발 환경 구성: 431. Visual Studio 2019 - CMake를 이용한 공유/실행(so/out) 리눅스 프로젝트 설정파일 다운로드1
11832정성태3/4/20191088오류 유형: 524. Visual Studio CMake - rsync: connection unexpectedly closed
11831정성태3/4/2019870오류 유형: 523. Visual Studio 2019 - 새 창으로 뜬 윈도우를 닫을 때 비정상 종료
11830정성태2/26/2019816오류 유형: 522. 이벤트 로그 - Error opening event log file State. Log will not be processed. Return code from OpenEventLog is 87.
11829정성태12/12/2019956개발 환경 구성: 430. 마이크로소프트의 CoreCLR 프로파일러 예제 빌드 방법 - 리눅스 환경 [1]
11828정성태2/26/20191725개발 환경 구성: 429. Component Services 관리자의 RuntimeBroker 설정이 2개 있는 경우
11827정성태2/26/20191265오류 유형: 521. Visual Studio - Could not start the 'rsync' command on the remote host, please install it using your system package manager.
11826정성태2/26/2019990오류 유형: 520. 우분투에 .NET Core SDK 설치 시 패키지 의존성 오류
11825정성태2/25/20192642개발 환경 구성: 428. Visual Studio 2019 - CMake를 이용한 리눅스 빌드 환경 설정 [1]
11824정성태2/25/20191398오류 유형: 519. The SNMP Service encountered an error while accessing the registry key SYSTEM\CurrentControlSet\Services\SNMP\Parameters\TrapConfiguration. [1]
1  2  3  4  5  6  7  8  9  10  11  12  [13]  14  15  ...