第3章 Apicurio Studio の使用を開始する
3.1. Apicurio Studio とは
Apicurio Studio を使用して、スキーマと API 定義を設計できます。API の所有者や開発者が、イベントスキーマおよび API 定義のコンテンツを容易に管理できる Web コンソールが提供されます。
Apicurio Studio を使用して、シンプルなテンプレートからスキーマまたは API 設計を作成することも、提供される詳細なテンプレートを使用することも、既存の設計をインポートして編集することもできます。作業中の設計は、DRAFT として Apicurio Registry に自動的に保存されます。納得のいくコンテンツが完成したら、Apicurio Registry で設計を ENABLED にプロモートできます。
Apicurio Studio は、Apicurio Studio オープンソースコミュニティープロジェクトをベースとしています。
主な概念
Apicurio Studio の仕組みを理解するには、次の主要な概念を理解する必要があります。
- Apicurio Studio Web コンソール
開発者が API およびスキーマ設計を作成、管理、整理する Web 環境。
Apicurio Studio Web コンソールを使用して、次のタスクを実行できます。
- Apicurio Studio に格納されているスキーマと API 設計を参照および検索する
- スキーマと API の新しい設計およびバージョンを追加する
- ファイル、URL、または Apicurio Registry インスタンスからコンテンツをインポートする
- 現在の編集セッションで加えた変更を表示する
- ドラフト
API 設計またはスキーマ設計。ローカルプロジェクトにダウンロードした場合、または Apicurio Registry で使用する場合、設計は アーティファクト と呼ばれます。
Apicurio Studio は、次の API タイプをサポートしています。
- AsyncAPI
- OpenAPI
Apicurio Studio は、次のスキーマタイプをサポートしています。
- Apache Avro
- JSON Schema
- Google Protocol Buffers (Protobuf)
Apicurio Studio のユースケース
Apicurio Studio の主なユースケースは次のとおりです。
コントラクトファーストのアプリケーション開発
Apicurio Studio を使用して、アプリケーションコードを書く前に、アプリケーションに必要な API およびデータモデル (コントラクト) を視覚的に設計できます。コントラクトを定義した後、そのコントラクトを満たすために必要なアプリケーションロジックを作成すると簡単です。Apicurio Studio で作成した設計から、Quarkus ベースのクライアントおよびサーバーアプリケーションを生成できます。
Apicurio Registry の設定
API およびスキーマの設計は、すべて Apicurio Registry に保存されます。Apicurio Registry 機能を使用できます。以下はその例です。
- 設計変更の検証ルールを作成する。
- Apicurio Registry REST API を使用して、複雑な JSON スキーマを逆参照する。
