APICurio — API is everything. API is cure.

Sujit Udhane

4 min readFeb 7, 2021

1.Apicurio Studio — Key Features

Web Based

Design your OpenAPI APIs in a web (browser based) application — no installation necessary.

Code-optional Design

Don’t know the OpenAPI specification inside and out? Now you don’t have to!

Open Source

The Apicurio Studio is fully open source, hosted on GitHub and actively maintained.

2.Apicurio Registry — Key Features

Storage/management of several types of artifacts

The registry supports adding, removing, and updating the following types of artifacts: OpenAPI, AsyncAPI, GraphQL, Apache Avro, Google protocol buffers, JSON Schema, Kafka Connect schema, WSDL, XML Schema (XSD)

Configurable content rules

Content evolution (adding and updating artifact content) can be controlled by enabling content rules, including Validity and Compatibility.

Multiple storage options

The registry can be configured to store data in various back-end storage systems depending on use-case, including Kafka, PostgreSQL, and Infinispan (embedded).

3.Apicurio Library -

The Apicurio Data Models library is a Java and Typescript compatible library that provides reading, writing, analysis, modification, and validation of OpenAPI and AsyncAPI documents. Use this library if you need to support either OpenAPI or AsyncAPI specifications in your own projects.

Key Features

Parsing into a formal model

OpenAPI and AsyncAPI content (typically JSON or YAML content) can be parsed into a formal, structured (tree-like) data model, much like XML or other structured content.

Visitor + Traverser patterns

Full support for the Visitor design pattern, for both a single Node in the model and also a traversal (up or down) of the full (or partial) document.

Validation of the model

Validate all, or only part, of the data model against all of the rules defined in the OpenAPI/AsyncAPI specifications.

Supports both Java and Typescript

Use this library in your Java, node.js, or browser based applications! It works the same no matter how you use it.

Convert OpenAPI 2.0 to OpenAPI 3.0

Includes a built-in transformer for easily converting older “Swagger” documents into the newer OpenAPI 3 format.

Robust $ref support

Provide your own $ref resolver so that the library can properly analyze/validate documents with external references. Also included is a built-in “dereferencer” which can transform a document with external references into one without any (by internalizing all of the refs)!

Library source code-

https://github.com/Apicurio/apicurio-data-models

https://www.npmjs.com/package/apicurio-data-models

4. How to use Apicurio — Step by Step guide