イントロダクション#
Kiota は、OpenAPI Specificationに基づいて API SDK を生成するためのマイクロソフトのオープンソースのクロスプラットフォームコマンドラインツールです。
完全な OpenAPI のサポートを提供するために、Microsoft.OpenAPI.NETを基礎として選択しました。
サポートされる言語#
C#、CLI、Go、Java、PHP、Python、Ruby、Swift、TypeScript などの言語に対応しており、サポートされるクライアントコードの言語の種類は、次のリンクでより詳細に確認できます:https://github.com/microsoft/kiota#supported-languages
インストール#
公式では、さまざまなインストール方法が提供されていますが、私は.NET ツールを使用してインストールすることにしました:
dotnet tool install --global Microsoft.OpenApi.Kiota
使用方法#
kiota
コマンドを直接実行すると、サポートされるパラメーターが表示されます。また、ドキュメントも参照できます。
例:
kiota generate --openapi https://petstore.swagger.io/v2/swagger.json --output d:\test --language TypeScript
API が更新された場合、SDK も更新する必要があります。注意点として、現在は--output
パラメーターを指定して、kiota がどのディレクトリの SDK を更新するかを指定する必要があります。出力ディレクトリ内で実行している場合でも、相対パス "." を指定する必要があります。
kiota update --output .
また、次のリンクをクリックして、各言語向けに生成された kiota のクライアントコードを確認できます:https://github.com/microsoft/kiota-samples
その他のツール#
- NSwag:Windows GUI ツールでクライアントコードを生成します。よく使用されます
- Swagger Editor:OpenAPI エディターで、サーバーおよびクライアントのコードを生成できます