Get Started with Apicurio Registry

The easiest way to get started with Apicurio Registry is by using Docker to quickly start up an in-memory server and UI.

Note: Apicurio Registry's back end and UI are now separate container images.

Note: this server is non-persistent, so don't use it for production!

Prerequisites

You have Docker (or Podman) installed.

Back End Server (REST API)

Pull the Apicurio Registry image

Pull the apicurio-registry Docker image from Docker Hub as follows:

docker pull apicurio/apicurio-registry:3.0.2

Run the Apicurio Registry image

Apicurio Registry supports different storage options, but the quickest way to get started is to use the non-persistent in-memory image with no external dependencies. Which storage variant that gets used depends on the configuration (ENV variables) you configure. By default, the in-memory variant will be chosen.

For more options, see the Apicurio Registry documentation.

Run the apicurio-registry Docker image as follows:

docker run -it -p 8080:8080 apicurio/apicurio-registry:3.0.2

User Interface

Pull the Apicurio Registry UI image

Pull the apicurio-registry-ui Docker image from Docker Hub as follows:

docker pull apicurio/apicurio-registry-ui:3.0.2

Run the Apicurio Registry UI image

Run the UI image on port 8888, because the back-end server's default settings allow it!

Run the `apicurio-registry-ui` Docker image as follows:

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

Open the Apicurio Registry web console

Open the Apicurio Registry web console in your browser to add API and schema artifacts to Apicurio Registry.