Get Started with Apicurio Studio
The easiest way to get started with Apicurio Studio is by using Docker to quickly start up an in-memory server.
Note: This server is non-persistent, so don't use this for production!
Prerequisites
Pull the Apicurio Studio images
Two container images are needed to run Apicurio Studio:
- Backend: apicurio/apicurio-studio
- User Interface: apicurio/apicurio-studio-ui
docker pull quay.io/apicurio/apicurio-studio:1.0.0.Beta1 docker pull quay.io/apicurio/apicurio-studio-ui:1.0.0.Beta1
Run the Apicurio Studio images
Apicurio Studio supports different storage options, but the quickest way to get started is to use the non-persistent in-memory image with no external dependencies. See the documentation to learn how to run a persistent server (e.g. using Postgresql).
Run both the apicurio-studio
and apicurio-studio-ui
Docker images as follows:
docker run -it -p 8080:8080 quay.io/apicurio/apicurio-studio:1.0.0.Beta1
docker run -it -p 8888:8080 quay.io/apicurio/apicurio-studio-ui:1.0.0.Beta1
Open the Apicurio Studio web console
Open the Apicurio Studio web console in your browser to start designing your own APIs and Schemas!