응용 프로그램에서 웹 API에 적합한 기술을 선택하는 방법

기타 응용 프로그램에서 웹 API에 적합한 기술을 선택하는 방법

추천0

페이지 정보

작성자 GrapeCity

작성일 2023-04-17 16:25 조회 180회 댓글 0건

본문

관련링크

최신 소프트웨어 개발에서 마이크로서비스 아키텍처는 인기 있는 선택입니다. 이유는 다양합니다. 이 아키텍처 패턴을 사용하면 마이크로서비스라고 하는 더 작고 독립된 단위로 분해하여 크고 복잡한 시스템을 구축할 수 있습니다.

각 마이크로서비스는 특정 기능을 담당하며 API를 통해 다른 마이크로서비스와 통신합니다. 이 접근 방법에는 향상된 유연성, 확장성 및 쉬운 배포와 같은 많은 이점이 있습니다.

웹 API는 서비스가 인터넷이나 인트라넷을 통해 서로 통신할 수 있는 방법을 제공하고 외부 시스템과의 느슨한 결합, 유연성 및 통합을 가능하게 함으로써 마이크로서비스 아키텍처에서 중요한 역할을 합니다. 웹 API에는 많은 기능이 있지만 이 블로그 게시물에서는 데이터에 대한 액세스를 제공하는 웹 API를 구체적으로 살펴볼 것입니다.

마이크로서비스 아키텍처에서 각 서비스는 자체 데이터 저장소를 가질 수 있으며, 웹 API는 다른 서비스가 이 데이터에 액세스하는 수단입니다. 웹 API는 데이터 저장소와 액세스해야 하는 서비스 사이의 다리 역할을 하여 서비스가 필요한 데이터에 액세스할 수 있는 일관되고 안전한 방법을 제공합니다.

또한 웹 API는 데이터 유효성 검사, 데이터 변환 및 데이터 일관성과 성능을 유지하는 데 필수적인 데이터 캐싱과 같은 작업도 처리할 수 있습니다. 데이터 액세스를 위해 웹 API를 사용하면 다양한 서비스를 데이터 저장소에 직접 연결하지 않고도 필요한 데이터에 액세스할 수 있으므로 외부 시스템과의 통합이 간편할 뿐만 아니라 간단한 확장성이 가능합니다.

데이터 형식 및 API 스타일

데이터를 교환하려면 웹 API 및 해당 소비자는 데이터가 표시된 형식에 동의해야 합니다. 가장 일반적인 데이터 형식은 JSON 및 XML입니다.

JSON은 사람이 쉽게 읽고 쓸 수 있으며 기계가 구문 분석하고 생성할 수 있는 경량의 데이터 교환 형식입니다. 또한 XML보다 덜 장황하여 데이터 전송에 보다 효율적인 선택입니다.

반면에 XML은 문서에서 사용되는 것과 같은 정형 데이터에 더 적합한 마크업 언어입니다. XML은 또한 데이터의 구조를 더 쉽게 이해할 수 있도록 자체적으로 설명합니다. 잘 알려진 "노스윈드(Northwind)" 데이터베이스에서 가지고 온, JSON 및 XML 형식으로 직렬화된 "제품" 레코드를 비교해 보겠습니다.

{
    "ProductID": 1,
    "ProductName": "Chai",
    "SupplierID": 1,
    "CategoryID": 1,
    "QuantityPerUnit": "10 boxes x 20 bags",
    "UnitPrice": 18.0000,
    "UnitsInStock": 39,
    "UnitsOnOrder": 0,
    "ReorderLevel": 10,
    "Discontinued": false
}

<Product>
    <ProductID>1</ProductID>
    <ProductName>Chai</ProductName>
    <SupplierID>1</SupplierID>
    <CategoryID>1</CategoryID>
    <QuantityPerUnit>10 boxes x 20 bags</QuantityPerUnit>
    <UnitPrice>18.0000</UnitPrice>
    <UnitsInStock>39</UnitsInStock>
    <UnitsOnOrder>0</UnitsOnOrder>
    <ReorderLevel>10</ReorderLevel>
    <Discontinued>false</Discontinued>
</Product>

특정 사용 사례 및 응용 프로그램의 요구 사항에 따라 CSV 및 프로토콜 버퍼와 같은 다른 데이터 형식도 사용됩니다. 데이터 형식 선택은 응용 프로그램의 요구 사항과 통합해야 하는 시스템에 따라 달라집니다.

데이터 형식뿐만 아니라 웹 API 및 해당 소비자는 데이터를 요청하고 수정하는 메서드에 동의해야 합니다. REST(Representational State Transfer), OData 및 GraphQL을 비롯하여 웹 API와 상호 작용하는 데 사용할 수 있는 몇 가지 접근 방법이 있습니다.

다음으로 각 스타일에 대해 상세히 살펴보겠습니다.

RESTful API

REST는 웹 API를 빌드하는 데 널리 사용되는 아키텍처 스타일입니다. HTTP 원칙 및 리소스 중심 아키텍처의 원칙을 기반으로 합니다. RESTful API는 표준 HTTP 메서드를 사용하여 리소스에 대한 작업을 수행합니다. 다음은 가장 일반적으로 사용되는 HTTP 메서드입니다.

GET: 리소스에 대한 정보를 검색합니다. 이 메서드는 데이터를 수정하지 않고 서버에서 검색하는 데 사용됩니다.
POST: 새 리소스를 만듭니다. 이 메서드는 데이터를 서버에 전송하여 새 리소스를 만드는 데 사용됩니다.
PUT: 기존 리소스를 업데이트합니다. 이 메서드는 데이터를 서버에 전송하여 기존 리소스를 업데이트하는 데 사용됩니다.
DELETE: 리소스를 삭제합니다. 이 메서드는 리소스를 서버에서 삭제하는 데 사용됩니다.
PATCH: 부분적으로 리소스를 업데이트합니다. 이 메서드는 데이터를 서버에 전송하여 리소스의 특정 부분을 업데이트하는 데 사용됩니다.

이러한 메서드는 일반적으로 작동 중인 리소스를 식별하는 특정 URI와 연관되어 있습니다. 예를 들어 [GrapeCity Demo Data Northwind API](https://demodata.grapecity.com/swagger/index.html?urls.primaryName=Restful NorthWind)는 제품 엔터티에 대해 다음 GET 요청을 지원합니다.

GET /northwind/api/v1/Products는 모든 제품 목록을 검색합니다.
GET /northwind/api/v1/Products/{id}는 특정 제품에 대한 정보를 검색합니다
GET /northwind/api/v1/Products/{id}/Category는 특정 제품의 범주에 대한 정보를 검색합니다

또한 일부 API는 RESTful API의 특정 사용 사례가 있는 HEAD, OPTIONS 및 CONNECT와 같은 다른 HTTP 메서드도 사용합니다.

RESTful API는 이러한 메서드를 표준적이고 일관된 방식으로 사용하므로 쉽게 이해하고 사용할 수 있습니다. 이는 REST가 웹 API를 빌드하는 인기 아키텍처 스타일인 이유 중 하나입니다.

OData API

OData(Open Data Protocol)는 데이터를 쿼리하고 업데이트하는 웹 프로토콜입니다. REST 아키텍처 스타일 위에 구축되었으며 데이터 API를 만들고 사용하기 위한 개방형 표준입니다. OData는 단순하고 표준화된 쿼리 언어를 사용하여 데이터를 표현하고 액세스하는 방법을 제공합니다. 또한 일괄 처리 및 변경 추적과 같은 고급 기능을 지원하므로 복잡한 시스템용 API를 빌드하는 데 적합합니다.

OData API는 엔터티 관계 모델을 기반으로 하며 엔터티는 리소스로 표현되고 URI로 식별됩니다. 리소스는 GET, POST, PUT, DELETE, PATCH와 같은 표준 HTTP 메서드를 사용하여 쿼리 및 수정할 수 있습니다. OData는 데이터를 필터링하고 정렬하며 페이지를 매기는 데 사용할 수 있는 쿼리 옵션 집합을 정의합니다. 이러한 옵션은 URI에서 쿼리 매개 변수로 전달됩니다.

예를 들어 [GrapeCity Demo Northwind OData API](https://demodata.grapecity.com/swagger/index.html?urls.primaryName=OData NorthWind)는 필터링 및 정렬을 적용하는 제품 엔터티를 선택할 수 있는 요청을 수락합니다.

/northwind/odata/v1/Products?$orderby=productName&$filter=CategoryId+eq+1

OData는 다음과 같은 고급 기능도 지원합니다.

서버 기반 페이징: 클라이언트가 필요한 데이터만 검색하여 전송되어야 하는 데이터의 양을 줄일 수 있습니다.
일괄 처리: 여러 작업이 단일 요청에 있는 서버로 전송되도록 하여 클라이언트와 서버 간 왕복 횟수를 줄여줍니다.
변경 내용 추적: 데이터가 서버에서 변경될 때 클라이언트가 알림을 받을 수 있습니다.

OData는 널리 채택되어 사용되고 있습니다. 많은 플랫폼, 프레임워크 및 프로그래밍 언어에서 지원되므로 복잡한 시스템용 API를 빌드하는 데 적합합니다. SharePoint, Dynamics CRM, SAP는 OData를 지원하는 시스템의 예입니다.

GraphQL API

GraphQL은 API를 빌드하고 액세스하기 위한 쿼리 언어이자 런타임입니다. Facebook에서 개발했으며 오픈 소스 기술입니다. GraphQL은 클라이언트가 고정된 데이터 집합을 검색하지 않고 서버에서 필요한 데이터를 정확히 지정할 수 있는 방법을 제공합니다. 이렇게 하면 다중 엔드포인트가 필요하지 않고 유선으로 전송해야 하는 데이터의 양이 줄어듭니다.

GraphQL에서 클라이언트는 쿼리에서 필요한 데이터의 구조를 정의하며 서버는 요청된 데이터만 반환합니다. 클라이언트는 검색하려는 필드를 지정할 수도 있고 서버는 이러한 필드만 반환합니다. 이렇게 하면 클라이언트가 필요한 데이터만 수신하므로 보다 효율적인 데이터 검색이 가능합니다.

예를 들어 GrapeCity Demo Northwind GraphQL API는 다음과 같은 쿼리를 지원합니다.

{
  orderdetails {
    product {
      productId
      productName
      category {
        categoryId
        categoryName
      }
    }
    quantity
    unitPrice
    discount
  }
}

결과는 주문한 제품 및 범주에 대한 정보가 포함된 모든 주문 세부 정보의 목록입니다.

GraphQL은 또한 유형 시스템을 통해 데이터의 구조를 지정하는 방법을 제공합니다. 이렇게 하면 클라이언트와 서버는 데이터 구조에 동의하고 데이터가 반환되기 전에 유효성을 검사하는 방법을 제공합니다.

GraphQL은 구독 사용을 통해 실시간 업데이트도 지원합니다. 이를 통해 클라이언트는 특정 이벤트를 구독하고 실시간으로 업데이트를 수신할 수 있으므로 실시간 응용 프로그램 빌드에 탁월한 선택입니다.

보고 마이크로서비스

보고 마이크로서비스는 다른 마이크로서비스에서 검색한 데이터를 기반으로 시각적 보고서를 만드는 작업을 담당합니다. 이 마이크로서비스에는 일반적으로 다음 두 가지 기본 기능이 있습니다.

데이터 검색: 마이크로서비스는 웹 API를 사용하여 다른 마이크로서비스의 데이터에 액세스합니다. 이 데이터는 보고서를 생성하는 데 사용됩니다.
보고서 생성: 마이크로서비스는 보고 라이브러리 또는 도구를 사용하여 시각적 보고서를 생성합니다. 여기에는 차트, 표, 맵과 같은 항목이 포함될 수 있습니다.

마이크로서비스에 대한 보고 도구를 고려하는 경우 마이크로서비스 간에 데이터를 교환하는 데 사용되는 데이터 프로토콜과 데이터 형식을 지원해야 합니다. 보고 도구는 웹 API에 쉽게 연결하고 표시된 형식으로 데이터를 검색할 수 있어야 합니다. 이렇게 하면 보고 도구는 보고서 생성에 필요한 데이터에 쉽고 효율적으로 액세스할 수 있습니다.

ActiveReportsJS는 Restful, OData, GraphQL 및 기타 API를 지원하는 100% 클라이언트 측 보고 솔루션입니다. 따라서 여러 서비스의 데이터에 쉽게 액세스할 수 있으므로 마이크로서비스 아키텍처용 보고서를 작성하는 데 적합합니다. 차트, 표 및 맵 등과 같은 광범위한 데이터 시각화 옵션을 사용하여 뛰어난 상호 작용 및 사용자 정의 가능한 보고서를 생성할 수 있습니다.

ActiveReportsJS는 웹 개발에서 널리 사용되는 JSON 형식과 호환 가능하며 다양한 서비스의 데이터를 쉽게 사용할 수 있습니다.

ActiveReportsJS Demo에서 제품 기능을 자세히 살펴보시길 바랍니다.

지금 바로 ActiveReportsJS를 다운로드하여 직접 테스트해 보세요!