【와티비커뮤니티-WATVcommunity】 보증업체놀이터추천홍보 : 프로그램제작판매제작의뢰 : 스포츠분석 : 무료스포츠중계tv : 섹시bj움짤 : 스포츠뉴스 : 안구정화 놀이터홍보 놀이터후기공유 피해사례공유

로그인

채팅

글쓰기

[IT뉴스]"최소한의 코드로 연결 간소화" 리핏으로 ASP.NET 코어에서 API를 소비하는 방법

온카뱅크관리자

2024-07-09 05:50:47

<div class="node-body">
<a href="https://github.com/reactiveui/refit" target="_blank">리핏(Refit)</a>은 닷넷, 닷넷 코어, 자마린(Xamarin)을 위한 오픈소스 라이브러리다. API 엔드포인트를 C# 인터페이스로 정의할 수 있도록 해서 HTTP 요청을 생성하고 HTTP 응답을 수동으로 파싱할 필요를 없애주므로 REST API를 더 간단하고 쉽게 사용할 수 있다. <br>
 
<figure class="image"><img alt="" border="1" height="480" onerror="removeImage($(this));" src="https://www.itworld.co.kr/files/itworld/ITW_202407_01/GettyImages-2159615298.jpg" width="640">
<figcaption>ⓒ Getty Images Bank</figcaption>
</figure>
<br>
여기서는 닷넷용 리핏 라이브러리를 살펴보면서 리핏을 통해 API 개발이 어떻게 간소화되는지 알아본다. 이 기사에 제공되는 코드 예제를 사용하려면 비주얼 스튜디오 2022가 설치돼 있어야 한다. 아직 없다면 마이크로소프트 홈페이지에서 <a href="https://visualstudio.microsoft.com/ko/vs/preview/" target="_blank">비주얼 스튜디오 2022를 다운로드</a>할 수 있다. <br>
<br>
아래 섹션에서 구현할 두 개의 애플리케이션은 연락처 API, 그리고 이 API를 소비하기 위한 클라이언트 애플리케이션이다. 연락처 API 애플리케이션은 다음과 같은 유형으로 구성된다. <br>
 
<ul>
	<li>Contact : 모델 클래스 </li>
	<li>IcontactRepository : 연락처 리포지토리를 위한 인터페이스 </li>
	<li>ContactRepository : 연락처 데이터를 반환하기 위한 메서드를 포함하는 연락처 리포지토리 클래스 </li>
	<li>ContactsController :연락처 API 엔드포인트를 API 클라이언트에 노출하는 데 사용되는 API 컨트롤러 </li>
</ul>
<br>
클라이언트 애플리케이션은 리핏을 사용해서 연락처 API를 소비하고 검색된 레코드를 콘솔 창에 표시한다. 
<h2>
<br>
리핏이란 무엇이고 왜 유용한가? </h2>
리핏은 닷넷, 닷넷 코어, 자마린을 위한 빠른 유형 안전(type-safe) REST 라이브러리로, REST API를 인터페이스로 바꿔서 RESTful 웹 서비스를 쉽게 소비할 수 있게 해준다. 리핏은 REST 작업을 기술하는 속성을 사용해서 HTTP 호출을 C# 인터페이스로 자동으로 변환하고 따라서 최소한의 코드를 사용해서 API 연결 과정을 간소화한다. <br>
<br>
리핏을 사용해 API를 소비하려면 API와 상호작용할 수 있는 인터페이스가 필요하다. 리핏은 이 인터페이스의 메서드를 둘러써는 래퍼 역할을 하며 HTTP 요청과 응답을 매끄럽게 처리한다. 리핏은 API에 액세스하는 데 필요한 상용구 코드를 자동으로 생성한다. <br>
<br>
리핏을 처음 사용한다면 먼저 기본 주소, HTTP 헤더, 직렬화, 역직렬화 정보 등을 지정해 HTTP 클라이언트 인스턴스를 구성해야 한다. 다음 코드는 ASP.NET 코어에서 HTTP 클라이언트 인스턴스를 구성해 엔드포인트에 연결하는 방법을 보여준다. <br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">string baseAddress = "http://localhost:59904/";<br>
HttpClient _client = new HttpClient();<br>
_client.BaseAddress = new Uri($"{BaseUrl}");<br>
_client.DefaultRequestHeaders.Accept.Clear();<br>
_client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));<br>
string url = BaseUrl + "api/authors";<br>
var response = await _client.GetAuthors(url);<br>
if (response.IsSuccessStatusCode)<br>
{ <br>
    var result = await response.Content.ReadAsStringAsync();<br>
    var data = JsonSerializer.Deserialize&lt;List&lt;Author&gt;&gt;(result);<br>
}</span></div>
<br>
이미 리핏을 사용 중이라면 이 상용구 코드에 대해 신경을 쓰지 않아도 된다. 리핏이 몇 줄의 C# 코드로 모든 작업을 처리할 수 있기 때문이다. <br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">string baseAddress = "http://localhost:59904/";<br>
var endpoint = RestService.For&lt;IAuthorService&gt;(baseAddress);<br>
var contacts = await endpoint.GetAuthors();</span></div>
<br>
앞서 나온 코드에서 볼 수 있듯이 리핏은 상용구 코드를 작성해야 할 필요를 없앰으로써 많은 시간과 작업을 절약해준다. <br>
<br>
다음 섹션에서는 ASP.NET 코어에서 간단한 웹 API를 구현한다. API를 만든 다음에는 이를 소비하기 위한 리핏 클라이언트를 구현한다. 
<h2>
<br>
비주얼 스튜디오 2022에서 ASP.NET 코어 웹 API 프로젝트 만들기 </h2>
비주얼 스튜디오 2022에서 ASP.NET 코어 8 웹 API를 만들려면 다음 단계를 따른다. <br>
 
<ol>
	<li>비주얼 스튜디오 2022 IDE를 실행한다. </li>
	<li>"새 프로젝트 만들기(Create new project)"를 클릭한다. </li>
	<li>"새 프로젝트 만들기" 창에 표시되는 템플릿 목록에서 "ASP.NET 코어 웹 API(ASP.NET Core Web API)"를 선택한다. </li>
	<li>다음(Next)을 클릭한다. </li>
	<li>"새 프로젝트 구성(Configure your new project)" 창에서 새 프로젝트의 이름과 위치를 지정한다. 옵션인 "솔루션과 프로젝트를 같은 디렉터리에 두기(Place solution and project in the same directory)" 확인란은 필요에 따라 선택한다. </li>
	<li>다음을 클릭한다. </li>
	<li>"추가 정보(Additional Information)" 창에서 "닷넷 8.0(장기 지원)(.NET 8.0 (Long Term Support))"을 프레임워크 버전으로 선택하고, "컨트롤러 사용(Use controllers)" 확인란을 선택한다. 이 프로젝트에서는 컨트롤러를 사용한다. </li>
	<li>"추가 정보" 창에서 "인증 유형(Authentication Type)"은 기본값인 "없음(None)"으로 두고, "오픈 API 지원 사용(Enable Open API Support)", "HTTPS용으로 구성(Configure for HTTPS)", "도커 사용(Enable Docker)" 확인란은 선택 해제한다. 이 기사에서는 사용하지 않는 기능들이다. </li>
	<li>만들기(Create)를 클릭한다. </li>
</ol>
<br>
아래 섹션에서 이 ASP.NET 코어 웹 API 프로젝트를 사용해서 API를 만들 것이다. 
<h2>
<br>
Contact 모델 클래스 만들기 </h2>
방금 만든 웹 API 프로젝트에서 Contact라는 이름의 새 클래스를 만들고 아래 코드를 입력한다. <br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">namespace Refit_Demo<br>
{<br>
    public class Contact<br>
    {<br>
        public int Id { get; set; }<br>
        public string FirstName { get; set; }<br>
        public string LastName { get; set; }<br>
        public string Address { get; set; }<br>
        public string Phone { get; set; }<br>
    }<br>
}</span></div>
<br>
다음 섹션에서는 Contact 클래스를 사용해서 데이터를 처리한다. 
<h2>
<br>
ContactRepository 클래스 만들기 </h2>
다음으로, Contact 데이터를 다루기 위한 리포지토리 클래스를 만든다. 여기서는 간단히 하기 위해 데이터를 목록으로 메모리에 저장한다. 각자의 요구사항에 따라 이 구현을 변경해서 데이터베이스에 데이터를 저장해도 된다. ContactRepository 클래스는 IContactRepository를 구현한다. 이 인터페이스에는 GetContact와 GetContacts, 두 개의 메서드 선언이 포함된다. 전자는 매개변수로 전달된 id를 기반으로 하나의 연락처 레코드를 반환하고, 후자는 모든 연락처를 반환한다. <br>
<br>
다음 코드는 IContactRepository 인터페이스와 ContactRepository 클래스를 모두 보여준다.<br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">public interface IContactRepository<br>
{<br>
    public Contact GetContact(int id);<br>
    public List&lt;Contact&gt; GetContacts();<br>
}<br>
public class ContactRepository: IContactRepository<br>
{<br>
    private readonly List&lt;Contact&gt; contacts = new List&lt;Contact&gt;();<br>
    public ContactRepository()<br>
    {<br>
        contacts = new List&lt;Contact&gt;()<br>
        {<br>
            new Contact()<br>
            { Id =1, FirstName = "Keaton", LastName = "Underwood",<br>
                Address = "12/3 ABC Road, Chicago, USA",<br>
            Phone = "1234567890"},<br>
            new Contact(){ Id = 2, FirstName = "John", LastName = "Smith",<br>
                Address = "12/3 ABC Road, New York, USA",<br>
            Phone = "0987654321"}<br>
        };<br>
    }<br>
    public Contact GetContact(int id)<br>
    {<br>
        return contacts.SingleOrDefault(c =&gt; c.Id == id);<br>
    }<br>
    public List&lt;Contact&gt; GetContacts()<br>
    {<br>
        return contacts;<br>
    }<br>
}</span></div>
<br>
다음 코드를 사용해서 IContactRepository 유형의 인스턴스를 Program.cs의 서비스 컬렉션에 등록할 수 있다. <br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">builder.Services.AddScoped&lt;IContactRepository, ContactRepository&gt;();</span></div>
<br>
이렇게 하면 종속성 주입을 사용해 애플리케이션에 IContactRepository 유형의 인스턴스를 만들 수 있게 된다. 
<h2>
<br>
API 컨트롤러 만들기 </h2>
이제 연락처 API를 위한 컨트롤러 클래스를 만들 차례다. ContactsController라는 이름으로 새 API 컨트롤러를 만들고 생성된 코드를 다음 코드로 대체한다. <br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">using Microsoft.AspNetCore.Mvc;<br>
namespace Refit_Demo.Controllers<br>
{<br>
    [Route("api/[controller]")]<br>
    [ApiController]<br>
    public class ContactsController : ControllerBase<br>
    {<br>
        private readonly IContactRepository _contactRepository;<br>
        public ContactsController(IContactRepository contactRepository)<br>
        {<br>
            _contactRepository = contactRepository;<br>
        }<br>
        [HttpGet]<br>
        public async Task&lt;List&lt;Contact&gt;&gt; Get()<br>
        {<br>
            return await _contactRepository.GetContacts();<br>
        }<br>
        [HttpGet("{id}")]<br>
        public async Task&lt;Contact&gt; Get(int id)<br>
        {<br>
            return await _contactRepository.GetContact(id);<br>
        }<br>
    }<br>
}</span></div>
<br>
앞의 코드 예시를 보면 생성자 주입을 사용해서 IContactRepository 유형의 인스턴스를 만들었다. 다음 섹션에서는 콘솔 애플리케이션 프로젝트를 만들고 연락처 API를 소비하는 리핏 클라이언트를 빌드한다. 
<h2>
<br>
비주얼 스튜디오에서 닷넷 코어 콘솔 애플리케이션 프로젝트 만들기 </h2>
아래 단계에 따라 비주얼 스튜디오에서 새 닷넷 코어 콘솔 애플리케이션 프로젝트를 만든다. <br>
 
<ol>
	<li>비주얼 스튜디오 IDE를 실행한다. </li>
	<li>"새 프로젝트 만들기"를 클릭한다. </li>
	<li>"새 프로젝트 만들기" 창에 표시되는 템플릿 목록에서 "콘솔 앱(닷넷 코어(Console App (.NET Core))"를 선택한다. </li>
	<li>다음을 클릭한다. </li>
	<li>"새 프로젝트 구성" 창에서 새 프로젝트의 이름과 위치를 지정한다. </li>
	<li>다음을 클릭한다. </li>
	<li>"추가 정보" 창에서 "닷넷 8.0(장기 지원)"을 사용할 프레임워크 버전으로 선택한다. </li>
	<li>만들기를 클릭한다. </li>
</ol>
<br>
이 닷넷 코어 콘솔 애플리케이션 프로젝트를 사용해 리핏 API 클라이언트를 만든다. 
<h2>
<br>
리핏 누겟 패키지 설치 </h2>
리핏을 프로젝트에 설치하려면 솔루션 탐색기 창에서 프로젝트를 선택한 다음 마우스 오른쪽 버튼을 클릭하고 "누겟 패키지 관리(Manage NuGet Packages)"를 선택한다. <br>
<br>
누겟 패키지 관리자 창에서 리핏 패키지를 검색해 설치한다. 또는 누겟 패키지 관리자 콘솔을 통해 다음 명령을 입력해서 패키지를 설치할 수도 있다. <br>
<br>
PM&gt; Install-Package Refit 
<h2>
<br>
리핏 API 클라이언트 만들기 </h2>
이제 Program.cs 파일에 생성된 코드를 다음 코드 예시로 대체한다. <br>
 
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><span style="font-family:Courier New,Courier,monospace;">using Refit;<br>
string baseAddress = "http://localhost:59904/";<br>
var contactsAPI = RestService.For&lt;IContactService&gt;(baseAddress);<br>
var contacts = await contactsAPI.GetContacts();<br>
foreach (var contact in contacts)<br>
{<br>
    Console.WriteLine($"{contact.Id} | {contact.FirstName} |<br>
    {contact.LastName}");<br>
}<br>
Console.ReadLine();<br>
[Headers("Accept: application/json", "Content-type: application/json")]<br>
public interface IContactService<br>
{<br>
    [Get("/api/contacts")]<br>
    public Task&lt;Contact&gt; GetContact(int id);<br>
    [Get("/api/contacts")]<br>
    public Task&lt;List&lt;Contact&gt;&gt; GetContacts();<br>
}<br>
public class Contact<br>
{<br>
    public int Id { get; set; }<br>
    public string FirstName { get; set; }<br>
    public string LastName { get; set; }<br>
    public string Address { get; set; }<br>
    public string Phone { get; set; }<br>
}</span></div>

<h2>
<br>
애플리케이션 실행 </h2>
이 예제에는 두 개의 애플리케이션이 있으므로 하나씩 두 개 모두 실행해야 한다. 먼저 API 애플리케이션을 실행한 다음 API 클라이언트 콘솔 애플리케이션을 실행한다. 두 애플리케이션이 모두 실행되면 그림 1과 같이 연락처 API 애플리케이션에서 검색된 데이터가 콘솔에 표시된다 <br>
 
<figure class="image"><img alt="" border="1" height="338" onerror="removeImage($(this));" src="https://www.itworld.co.kr/files/itworld/ITW_202407_01/refit-aspnet-core-100963313-larg.jpg" width="640">
<figcaption>리핏 API 클라이언트 실행 모습 ⓒ Foundry</figcaption>
</figure>
<br>
리핏은 HTTP REST API 클라이언트 구현에 적합하다. 리핏은 ASP.NET 코어 애플리케이션에서 REST API에 연결하고 이를 사용하는 데 필요한 상용구 코드를 대폭 간소화해준다. 한 가지 중요한 참고 사항은 리핏을 사용할 때 모든 요청은 비동기 요청이어야 한다는 점이다. 리핏은 동기 네트워크 호출을 지원하지 않는다.  <br>
editor@itworld.co.kr</div>

제니, 얼굴에 담배 연기를? 실내 흡연 논란..소속사 "입장 정리 중" 김여사 문자 5통 유출 미스터리…사생결단 치닫는 친윤-친한 갈등

댓글 총 0개

업체홍보/구인 더보기

놀이터홍보 더보기

지식/노하우 더보기

판매의뢰 더보기

포토 더보기