3.4. Service Registry Web コンソールを使用した OpenAPI アーティファクト用のクライアント SDK の生成
Service Registry Web コンソールを使用して、OpenAPI アーティファクトのクライアントソフトウェア開発キット (SDK) を設定、生成、ダウンロードできます。続いて、生成されたクライアント SDK を使用して、OpenAPI に基づいて特定のプラットフォーム用のクライアントアプリケーションを構築できます。
Service Registry は、次のプログラミング言語用のクライアント SDK を生成します。
- C#
- Go
- Java
- PHP
- Python
- Ruby
- Swift
- TypeScript
OpenAPI アーティファクトのクライアント SDK の生成はブラウザー内でのみ実行され、API を使用して自動化することはできません。新しいアーティファクトバージョンが Service Registry に追加されるたびに、クライアント SDK を再生成する必要があります。
前提条件
- Service Registry が環境にインストールされ、実行している。
Service Registry Web コンソールにログインしている。
http://MY_REGISTRY_URL/ui- Web コンソール、コマンドライン、Maven プラグイン、または Java クライアントアプリケーションを使用して、OpenAPI アーティファクトが Service Registry に追加されました。
手順
- Artifacts タブで、Service Registry に保存されているアーティファクトのリストを参照するか、検索文字列に入力して特定の OpenAPI アーティファクトを見つけます。リストから選択して、名前、グループ、ラベル、グローバル ID などの条件で検索できます。
- リスト内の OpenAPI アーティファクトをクリックして、その詳細を表示します。
Version metadata セクションで、Generate client SDK をクリックし、ダイアログで以下を設定します。
- Language: クライアント SDK を生成するプログラミング言語 (Java など) を選択します。
-
Generated client class name: クライアント SDK のクラス名 (例:
MyJavaClientSDK.) を入力します。 -
Generated client package name: クライアント SDK のパッケージ名 (例:
io.my.example.sdk) を入力します。
Show advanced settings をクリックして、包含または除外するパスパターンのオプションのコンマ区切りリストを設定します。
-
Include path patterns: クライアント SDK の生成時に含める特定のパス (例:
**/.*, **/my-path/*) を入力します。このフィールドが空の場合、すべてのパスが含まれています。 Exclude path patterns: クライアント SDK の生成時に除外する特定のパス (例:
**/my-other-path/*) を入力します。このフィールドが空の場合、すべてのパスは除外されません。図3.4 Service Registry Web コンソールでの Java クライアント SDK の生成
-
Include path patterns: クライアント SDK の生成時に含める特定のパス (例:
- ダイアログで設定を行ったら、Generate and download をクリックします。
-
ダイアログにクライアント SDK のファイル名 (例:
my-client-java.zip) を入力し、Save をクリックしてダウンロードします。
関連情報
- Service Registry は、Microsoft の Kiota を使用してクライアント SDK を生成します。詳細は、GitHub の Kiota プロジェクト を参照してください。
- 生成された SDK を使用してクライアントアプリケーションをビルドする方法の詳細と例については、Kiota のドキュメント を参照してください。
