.NET OpenAPI ツールのコマンド リファレンスとインストール

Microsoft.dotnet-openapi は、プロジェクト内での OpenAPI 参照を管理するための .NET Core グローバル ツールです。

インストール

Microsoft.dotnet-openapi をインストールするには次のコマンドを実行します。

dotnet tool install -g Microsoft.dotnet-openapi

Note

既定では、インストールする .NET バイナリのアーキテクチャは、現在実行中の OS アーキテクチャを表します。 別の OS アーキテクチャを指定するには、「dotnet tool install, --arch option」を参照してください。 詳細については、GitHub イシュー dotnet/AspNetCore.Docs #29262 を参照してください。

追加

このページのコマンドのいずれかを使用して OpenAPI 参照を追加すると、次のような <OpenApiReference /> 要素が .csproj ファイルに追加されます。

<OpenApiReference Include="openapi.json" />

前の参照は、生成されるクライアント コードをアプリが呼び出すために必要です。

ファイルの追加

[オプション]

短いオプション	長いオプション	説明	例
-p	--updateProject	操作対象のプロジェクト。	dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	参照に適用するコード ジェネレーター。 オプションは NSwagCSharp と NSwagTypeScript です。 --code-generator を指定しない場合、ツールは既定で NSwagCSharp になります。	dotnet openapi add file .\OpenApi.json --code-generator
-h	--help	ヘルプ情報を表示します。	dotnet openapi add file --help

引数

Argument	説明	例
source-file	参照の作成元のソース。 OpenAPI ファイルである必要があります。	dotnet openapi add file .\OpenAPI.json

URL の追加

[オプション]

短いオプション	長いオプション	説明	例
-p	--updateProject	操作対象のプロジェクト。	dotnet openapi add url --updateProject .\Ref.csproj https://contoso.com/openapi.json
-o	--output-file	OpenAPI ファイルのローカル コピーを配置する場所。	dotnet openapi add url https://contoso.com/openapi.json --output-file myclient.json
-c	--code-generator	参照に適用するコード ジェネレーター。 オプションは NSwagCSharp と NSwagTypeScript です。	dotnet openapi add url https://contoso.com/openapi.json --code-generator
-h	--help	ヘルプ情報を表示します。	dotnet openapi add url --help

引数

Argument	説明	例
source-URL	参照の作成元のソース。 URL である必要があります。	dotnet openapi add url https://contoso.com/openapi.json

削除

指定したファイル名と一致する OpenAPI 参照を .csproj ファイルから削除します。 OpenAPI 参照が削除されると、クライアントは生成されません。 ローカルの .json ファイルと .yaml ファイルは削除されます。

[オプション]

短いオプション	長いオプション	説明	例
-p	--updateProject	操作対象のプロジェクト。	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	ヘルプ情報を表示します。	dotnet openapi remove --help

引数

Argument	説明	例
source-file	削除する参照のソース。	dotnet openapi remove .\OpenAPI.json

最新のステータスに更新

ダウンロード URL の最新のコンテンツを使用してダウンロードされたファイルのローカル バージョンを更新します。

[オプション]

短いオプション	長いオプション	説明	例
-p	--updateProject	操作対象のプロジェクト。	dotnet openapi refresh --updateProject .\Ref.csproj https://contoso.com/openapi.json
-h	--help	ヘルプ情報を表示します。	dotnet openapi refresh --help

引数

Argument	説明	例
source-URL	最新状態にする参照の URL。	dotnet openapi refresh https://contoso.com/openapi.json