Introduction to Apicurio Studio

Discover the features and functions available in the Apicurio Studio.

What is Apicurio Studio?

Apicurio Studio enables you to design schemas and API definitions. It provides a web console to make it easy for API owners and developers to manage the content of event schemas and API definitions.

You can use Apicurio Studio to create a schema or API design from a simple template, use one of the detailed templates provided, or import an existing design to edit it.

Key concepts

To understand how Apicurio Studio works, it is important to understand the following key concepts:

Apicurio Studio web console

The web environment where developers create, manage, and organize their API and schema designs.

You can use the Apicurio Studio web console to complete the following tasks:

  • Browse and search the schema and API designs that are stored in Apicurio Studio

  • Add new schema and API designs and versions

  • Import content from a file, from a URL, or from a Apicurio Registry instance

  • Show the changes that you have made in your current editing session

Design

An API design or schema design. When downloaded to a local project, or used in Apicurio Registry, designs are referred to as artifacts.

Apicurio Studio supports the following API types:

  • AsyncAPI

  • OpenAPI

Apicurio Studio supports the following schema types:

  • Apache Avro

  • JSON Schema

  • Google Protocol Buffers (Protobuf)

Apicurio Studio use cases

The main use cases for Apicurio Studio are as follows:

  • Contract-first application development

    You can use Apicurio Studio to visually design the API and data models (contracts) required by your applications, before you write any application code. After you define the contract, it is easier to create the application logic needed to satisfy the contract. You can generate Quarkus-based client and server applications from designs created in Apicurio Studio.