Introduction to Red Hat OpenShift API Designer

Guide
  • Red Hat OpenShift API Designer 1
  • Updated 17 August 2022
  • Published 30 June 2022

Introduction to Red Hat OpenShift API Designer

Guide
Red Hat OpenShift API Designer 1
  • Updated 17 August 2022
  • Published 30 June 2022

Discover the features and functions available in the Red Hat OpenShift API Designer cloud service.

What is Red Hat OpenShift API Designer?

Red Hat OpenShift API Designer is a managed cloud service that enables you to design schemas and API definitions without having to install, configure, run, and maintain your own infrastructure. Red Hat OpenShift API Designer provides a web console to make it easy for API owners and developers to manage the content of event schemas and API definitions.

Your Red Hat account gives you access to Red Hat OpenShift API Designer. No additional configuration is required; you can immediately start designing the schema or API definition that you need. You can use Red Hat OpenShift API Designer 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. When you’re happy with your content, you can save your design to a file or export it to Red Hat OpenShift Service Registry for use in your client applications.

Red Hat OpenShift API Designer is based on the Apicurio Studio open source community project.

In the Service Preview release of Red Hat OpenShift API Designer, all designs are stored locally in your browser. Clearing your browser cache or switching to a new browser might result in loss of data. Make sure you save your work by downloading your designs locally or by exporting them to a Red Hat OpenShift Service Registry instance.

Key concepts

To understand how Red Hat OpenShift API Designer works, it’s important to understand the following key concepts:

  • Red Hat OpenShift API Designer web console

    The web environment where users from an organization can manage designs. Red Hat OpenShift API Designer provides a single web console instance per organization without any configuration steps by the user.

  • Design

    An API design or schema design. When downloaded to a local project, or exported into Red Hat OpenShift Service Registry, designs are referred to as artifacts.

Red Hat OpenShift API Designer capabilities

The Service Preview release of Red Hat OpenShift API Designer has the following key capabilities:

  • Creation of APIs and schemas in a visual editor

  • Increased developer productivity with code and test generation from downloaded designs

  • Integration with OpenShift Service Registry for importing and exporting designs

  • Validity and version-compatibility testing of design content using OpenShift Service Registry rules

Red Hat OpenShift API Designer use cases

The main use cases for Red Hat OpenShift API Designer are as follows:

  • Contract-first application development

    You can use Red Hat OpenShift API Designer 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’s much easier to create the application logic needed to satisfy the contract. You can generate Quarkus-based client and server applications from designs created in Red Hat OpenShift API Designer.

  • Schema editing for Kafka applications

    When you use Kafka to produce and consume messages, you can define the data shape of your message payloads by using one of a number of event schema types. When you need to define a new schema, you can use Red Hat OpenShift API Designer.

Integration with other Red Hat cloud services

Red Hat OpenShift API Designer integrates with the following Red Hat cloud services:

  • Red Hat OpenShift Streams for Apache Kafka

    You can edit your Kafka topics in OpenShift API Designer to ensure that they map to the appropriate schemas.

  • Red Hat OpenShift Service Registry

    You can import artifacts from OpenShift Service Registry into OpenShift API Designer to edit the content. When you’re happy with the content of the schema and API designs, you can export the content to OpenShift Service Registry.

  • Red Hat OpenShift API Management

    You can save an API design to a file, and then add the design as an API in OpenShift API Management to manage the content.

Supported API and schema types

In the Service Preview release, Red Hat OpenShift API Designer supports the following API types:

  • AsyncAPI

  • OpenAPI

In the Service Preview release, Red Hat OpenShift API Designer supports the following schema types:

  • Apache Avro

  • JSON Schema

  • Google Protocol Buffers (Protobuf)

Managing Red Hat OpenShift API Designer content

In the Service Preview release, you can manage OpenShift API Designer content in the OpenShift API Designer web console.

OpenShift API Designer web console

You can use the OpenShift API Designer web console to complete the following tasks:

  • Browse and search the schema and API designs that are stored in OpenShift API Designer

  • Add new schema and API designs and versions

  • Import content from a file, from a URL, or from a Red Hat OpenShift Service Registry instance

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

  • Validate the content of a design against rules configured in your OpenShift Service Registry instance

  • Save your content to a file or to an OpenShift Service Registry instance

Guided help with tours and quick starts

The web console has guided tours and quick starts to guide you through common tasks:

  • Click the light-bulb icon in the console to display a list of tours. Take a tour to learn how to use the service, and how to navigate the console to find information.

  • Navigate to Learning Resources to find quick starts for specific goals. Each quick start has guided steps for a clearly defined set of tasks.

    You might begin with the Getting started with Red Hat OpenShift Service Registry quick start. When you have a Red Hat OpenShift Service Registry instance running, the Getting started with Red Hat OpenShift API Designer quick start shows you how to create a design or import a design from OpenShift Service Registry, and how to export updated designs to OpenShift Service Registry.

Try out Red Hat OpenShift API Designer

Red Hat OpenShift API Designer is available as a freely entitled cloud service to all users of the Red Hat Hybrid Cloud Console. To learn more, go to Red Hat Hybrid Cloud Console.

Service Preview

Service Preview releases provide early access to a limited set of features that might not be fully tested. Users should not use Service Preview software in production or for business-critical workloads.

If you need help

OpenShift API Designer is a Service Preview offering only and so you cannot open a Red Hat support case if you have questions or need assistance. If you need help with using OpenShift API Designer, send an email to: rhosak-eval-support@redhat.com