Apicurio Registry 安装及使用指南

Apicurio Registry 安装及使用指南

apicurio-registryAn API/Schema registry - stores APIs and Schemas.项目地址:https://gitcode.com/gh_mirrors/ap/apicurio-registry

一、项目介绍

Apicurio Registry 是一个高性能运行时注册表，用于存储和管理API设计和模式文件，支持多种文件类型，如OpenAPI、AsyncAPI等。它的主要功能包括添加、更新和删除存储中的工件，提供远程REST API接口进行操作。Apicurio Registry的核心用途之一是作为API注册表，让用户可以注册API设计，便于潜在用户发现并使用。

二、项目快速启动

下载与安装

首先，从GitHub仓库克隆或fork项目：

git clone https://github.com/Apicurio/apicurio-registry.git

然后，构建项目：

mvn clean install -DskipTests -Pprod -Ddocker

接下来配置PostgreSQL数据库，创建一个docker-compose.yml文件（例如命名为test.yml）：

version: '3.1'
services:
  postgres:
    image: postgres
    environment:
      POSTGRES_USER: apicurio-registry
      POSTGRES_PASSWORD: password
  app:
    image: apicurio/apicurio-registry:3.0.0-SNAPSHOT
    ports:
      - "8080:8080"
    environment:
      # 配置项示例

确保你的环境变量正确指向了PostgreSQL实例。

启动UI容器

除了主服务之外，还需要运行UI容器以访问界面：

docker run -it -p 8888:8080 apicurio/apicurio-registry-ui:latest-snapshot

此时，Apicurio Registry UI可在以下URL中访问：

• API 文档：http://YOUR_HOST_IP:8080/api-docs
• 用户界面：http://YOUR_HOST_IP:8888

三、应用案例和最佳实践

Apicurio Registry 主要应用于以下几个场景：

• API 注册：为API设计文件如OpenAPI或AsyncAPI提供集中注册。
• 内容治理：规则设置，对数据模型进行验证和版本兼容性检查。
• 生态整合：与Apache Kafka的集成，实现消息系统的模式注册。

通过web控制台、REST API以及Java客户端等方式，可以有效地管理和控制API工件的生命周期状态和元数据。

四、典型生态项目

Apicurio Registry 能够很好地与其他开源技术栈相结合，比如在AMQ Streams 或者 PostgreSQL 数据库中存储规则。此系统还支持Kafka等消息中间件，确保事件处理的高效性和一致性，非常适合微服务架构下的跨服务通信标准制定和管控。

此外，在实际部署中，可以通过Red Hat产品目录提供的Container镜像进行安装，这提供了极大的便利性和可维护性，尤其是对于企业级项目而言。

apicurio-registryAn API/Schema registry - stores APIs and Schemas.项目地址:https://gitcode.com/gh_mirrors/ap/apicurio-registry