1.2. 서비스 레지스트리의 스키마 및 API 아티팩트

이벤트 스키마 및 API 디자인과 같은 서비스 레지스트리에 저장된 항목은 레지스트리 아티팩트 라고 합니다. 다음은 간단한 공유 가격 애플리케이션의 JSON 형식의 Apache Avro 스키마 아티팩트 예제를 보여줍니다.

{
   "type": "record",
   "name": "price",
   "namespace": "com.example",
   "fields": [
       {
           "name": "symbol",
           "type": "string"
       },
       {
           "name": "price",
           "type": "string"
       }
   ]
}

{
   "type": "record",
   "name": "price",
   "namespace": "com.example",
   "fields": [
       {
           "name": "symbol",
           "type": "string"
       },
       {
           "name": "price",
           "type": "string"
       }
   ]
}

그런 다음 클라이언트 애플리케이션이 서비스 레지스트리에 아티팩트로 스키마 또는 API 설계를 추가하면 클라이언트 메시지가 런타임 시 올바른 데이터 구조를 준수하는지 검증할 수 있습니다.

스키마 및 API 그룹

아티팩트 그룹은 스키마 또는 API 아티팩트의 선택적 이름이 지정된 컬렉션입니다. 각 그룹에는 일반적으로 특정 애플리케이션 또는 조직에 속하는 단일 엔티티에 의해 관리되는 논리적 관련 스키마 또는 API 디자인 세트가 포함되어 있습니다.

스키마 및 API 설계를 추가하여 서비스 레지스트리에서 구성할 때 선택적 아티팩트 그룹을 생성할 수 있습니다. 예를 들어 개발 및 프로덕션 애플리케이션 환경 또는 영업 및 엔지니어링 조직에 맞는 그룹을 생성할 수 있습니다.

스키마 및 API 그룹은 여러 아티팩트 유형을 포함할 수 있습니다. 예를 들어 동일한 그룹에 Protobuf, Avro, JSON Schema, OpenAPI 또는 AsyncAPI 아티팩트가 모두 있을 수 있습니다.

서비스 레지스트리 웹 콘솔, REST API, 명령줄, Maven 플러그인 또는 Java 클라이언트 애플리케이션을 사용하여 스키마 및 API 아티팩트 및 그룹을 생성할 수 있습니다. 다음 간단한 예제에서는 Core Registry REST API를 사용하는 방법을 보여줍니다.

curl -X POST -H "Content-type: application/json; artifactType=AVRO" \
  -H "X-Registry-ArtifactId: share-price" \
  --data '{"type":"record","name":"price","namespace":"com.example", \
   "fields":[{"name":"symbol","type":"string"},{"name":"price","type":"string"}]}' \
  https://my-registry.example.com/apis/registry/v2/groups/my-group/artifacts

$ curl -X POST -H "Content-type: application/json; artifactType=AVRO" \
  -H "X-Registry-ArtifactId: share-price" \
  --data '{"type":"record","name":"price","namespace":"com.example", \
   "fields":[{"name":"symbol","type":"string"},{"name":"price","type":"string"}]}' \
  https://my-registry.example.com/apis/registry/v2/groups/my-group/artifacts

이 예제에서는 my-group 이라는 아티팩트 그룹을 생성하고 공유 변형의 아티팩트 ID가 포함된 Avro 스키마를 추가합니다.

다른 스키마 및 API에 대한 참조

일부 서비스 레지스트리 아티팩트 유형에는 한 아티팩트 파일에서 다른 아티팩트 파일로의 아티팩트 참조가 포함될 수 있습니다. 재사용 가능한 스키마 또는 API 구성 요소를 정의한 다음 여러 위치에서 참조하여 유효성을 높일 수 있습니다. 예를 들어, $ref 문을 사용하여 JSON 스키마 또는 OpenAPI에서 참조를 지정하거나 import 문을 사용하거나 중첩 네임스페이스를 사용하는 Apache Avro에서 Google Protobuf에서 지정할 수 있습니다.

다음 예제에서는 중첩 네임스페이스를 사용하여 Exchange 라는 다른 스키마에 대한 참조를 포함하는 IRQ Key 라는 간단한 Avro 스키마를 보여줍니다.

{
 "namespace": "com.kubetrade.schema.trade",
 "type": "record",
 "name": "TradeKey",
 "fields": [
   {
     "name": "exchange",
     "type": "com.kubetrade.schema.common.Exchange"
   },
   {
     "name": "key",
     "type": "string"
   }
 ]
}

{
 "namespace": "com.kubetrade.schema.trade",
 "type": "record",
 "name": "TradeKey",
 "fields": [
   {
     "name": "exchange",
     "type": "com.kubetrade.schema.common.Exchange"
   },
   {
     "name": "key",
     "type": "string"
   }
 ]
}

{
 "namespace": "com.kubetrade.schema.common",
 "type": "enum",
 "name": "Exchange",
 "symbols" : ["GEMINI"]
}

{
 "namespace": "com.kubetrade.schema.common",
 "type": "enum",
 "name": "Exchange",
 "symbols" : ["GEMINI"]
}

아티팩트 참조는 서비스 레지스트리에 아티팩트 유형별 참조에서 내부 서비스 레지스트리 참조에 매핑되는 아티팩트 메타데이터의 컬렉션으로 저장됩니다. 서비스 레지스트리의 각 아티팩트 참조는 다음으로 구성됩니다.

Service Registry core REST API, Maven 플러그인 및 Java serializers/deserializers(SerDes)를 사용하여 아티팩트 참조를 관리할 수 있습니다. 서비스 레지스트리는 아티팩트 콘텐츠와 함께 아티팩트 참조를 저장합니다. 서비스 레지스트리는 또한 모든 아티팩트 참조 컬렉션을 유지 관리하므로 이를 검색하거나 특정 아티팩트에 대한 모든 참조를 나열할 수 있습니다.

지원되는 아티팩트 유형

Service Registry는 현재 다음 아티팩트 유형에 대한 아티팩트 참조만 지원합니다.