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

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

비밀번호

댓글 쓴 사람
 




... [16]  17  18  19  20  21  22  23  24  25  26  27  28  29  30  ...
NoWriterDateCnt.TitleFile(s)
11913정성태5/24/20191349.NET Framework: 838. C# - 숫자형 타입의 bit(2진) 문자열, 16진수 문자열 구하는 방법파일 다운로드1
11912정성태5/23/20191365VS.NET IDE: 137. Visual Studio 2019 버전 16.1부터 리눅스 C/C++ 프로젝트에 추가된 WSL 지원
11911정성태5/23/20191490VS.NET IDE: 136. Visual Studio 2019 - 리눅스 C/C++ 프로젝트에 인텔리센스가 동작하지 않는 경우
11910정성태5/24/20192850Math: 50. C# - MathNet.Numerics의 Matrix(행렬) 연산파일 다운로드1
11909정성태5/25/20192020.NET Framework: 837. C# - PLplot 사용 예제 [1]파일 다운로드1
11908정성태5/22/20191317.NET Framework: 836. C# - Python range 함수 구현파일 다운로드1
11907정성태6/4/20191053오류 유형: 541. msbuild - MSB4024 The imported project file "...targets" could not be loaded
11906정성태5/21/2019894.NET Framework: 835. .NET Core/C# - 리눅스 syslog에 로그 남기는 방법
11905정성태5/21/20191292.NET Framework: 834. C# - 폴더 경로 문자열에서 "..", "." 표기를 고려한 최종 문자열을 얻는 방법 - 두 번째 이야기
11904정성태5/21/20192677.NET Framework: 833. C# - Open Hardware Monitor를 이용한 CPU 온도 정보파일 다운로드1
11903정성태5/21/20191461오류 유형: 540. .NET Core - System.PlatformNotSupportedException: The named version of this synchronization primitive is not supported on this platform.
11902정성태5/21/2019971오류 유형: 539. mstest 실행 시 "The directory name is invalid." 오류 발생
11901정성태5/21/20191650오류 유형: 538. msbuild 오류 - Could not find a part of the path '%LOCALAPPDATA%\Temp\2\.NETFramework,Version=v4.0.AssemblyAttributes.cs'
11900정성태3/12/20201555오류 유형: 537. "sfc /scannow" 실행 중 시스템이 부팅되는 현상
11899정성태5/17/20191654Linux: 9. Linux에서 윈도우의 OutputDebugString 대신 사용할 수 있는 syslog [1]
11898정성태5/20/20191738VC++: 130. C++ string의 c_str과 data 함수의 차이점 [3]
11897정성태5/16/20193191오류 유형: 536. Visual Studio - "Developer Pack"을 설치했는데도 "대상 프레임워크" 목록에 나오지 않는 경우 [1]
11896정성태5/15/20192446개발 환경 구성: 440. C#, C++ - double의 Infinity, NaN 표현 방식파일 다운로드1
11895정성태5/12/20191647.NET Framework: 832. ML.NET Model Builder - 회귀(Regression), 다중 분류(Multi-class classification) 예제파일 다운로드1
11894정성태5/12/20192283VS.NET IDE: 135. Visual Studio - ML.NET Model Builder 소개 [1]
11893정성태5/10/20191764오류 유형: 535. C# 6.0 이상의 문법을 컴파일 시 오류가 발생한다면?
11892정성태5/10/20191170웹: 38. HTTP Cookie의 expires 시간 형식(RFC7231)
11891정성태5/9/20191491.NET Framework: 831. (번역글) .NET Internals Cookbook Part 12 - Memory structure, attributes, handles
11890정성태5/8/20191171개발 환경 구성: 439. "Visual Studio Enterprise is required to execute the test." 메시지와 관련된 코드 기록
11889정성태5/8/20191315개발 환경 구성: 438. mstest, QTAgent의 로그 파일 설정 방법
11888정성태5/8/20192717.NET Framework: 830. C# - 비동기 호출을 취소하는 CancellationToken의 간단한 예제 코드파일 다운로드1
... [16]  17  18  19  20  21  22  23  24  25  26  27  28  29  30  ...