Referensi dan penginstalan perintah alat .NET OpenAPI

Microsoft.dotnet-openapi adalah Alat Global .NET Core untuk mengelola referensi OpenAPI dalam proyek.

Penginstalan

Untuk menginstal Microsoft.dotnet-openapi, jalankan perintah berikut:

dotnet tool install -g Microsoft.dotnet-openapi

Catatan

Secara default arsitektur biner .NET yang akan diinstal mewakili arsitektur OS yang sedang berjalan. Untuk menentukan arsitektur OS yang berbeda, lihat penginstalan alat dotnet, opsi --arch. Untuk informasi selengkapnya, lihat Masalah GitHub dotnet/AspNetCore.Docs #29262.

Menambahkan

Menambahkan referensi OpenAPI menggunakan salah satu perintah di halaman ini menambahkan elemen yang <OpenApiReference /> mirip dengan yang berikut ini ke .csproj file:

<OpenApiReference Include="openapi.json" />

Referensi sebelumnya diperlukan agar aplikasi memanggil kode klien yang dihasilkan.

Tambahkan File

Opsi

Opsi singkat	Opsi panjang	Deskripsi	Contoh
-p	--updateProject	Proyek yang akan dioperasikan.	dotnet openapi tambahkan file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	Generator kode untuk diterapkan ke referensi. Opsinya adalah: NSwagCSharp dan NSwagTypeScript. Jika --code-generator tidak ditentukan, alat default ke NSwagCSharp.	dotnet openapi tambahkan file .\OpenApi.json --code-generator
-h	--help	Perlihatkan informasi bantuan	dotnet openapi tambahkan file --help

Argumen

Argumen	Deskripsi	Contoh
file sumber	Sumber untuk membuat referensi. Harus berupa file OpenAPI.	dotnet openapi tambahkan file .\OpenAPI.json

Tambahkan URL

Opsi

Opsi singkat	Opsi panjang	Deskripsi	Contoh
-p	--updateProject	Proyek yang akan dioperasikan.	dotnet openapi tambahkan url --updateProject .\Ref.csproj https://contoso.com/openapi.json
o-	--output-file	Tempat menempatkan salinan lokal file OpenAPI.	dotnet openapi tambahkan url https://contoso.com/openapi.json --output-file myclient.json
-c	--code-generator	Generator kode untuk diterapkan ke referensi. Opsinya adalah: NSwagCSharp dan NSwagTypeScript.	dotnet openapi tambahkan url https://contoso.com/openapi.json --code-generator
-h	--help	Perlihatkan informasi bantuan	dotnet openapi tambahkan url --help

Argumen

Argumen	Deskripsi	Contoh
URL sumber	Sumber untuk membuat referensi. Harus berupa URL.	dotnet openapi tambahkan url https://contoso.com/openapi.json

Hapus

Menghapus referensi OpenAPI yang cocok dengan nama file yang diberikan dari .csproj file. Saat referensi OpenAPI dihapus, klien tidak akan dibuat. Lokal .json dan .yaml file dihapus.

Opsi

Opsi singkat	Opsi panjang	Deskripsi	Contoh
-p	--updateProject	Proyek yang akan dioperasikan.	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	Perlihatkan informasi bantuan	dotnet openapi remove --help

Argumen

Argumen	Deskripsi	Contoh
file sumber	Sumber untuk menghapus referensi.	dotnet openapi remove .\OpenAPI.json

Refresh

Menyegarkan versi lokal file yang diunduh menggunakan konten terbaru dari URL unduhan.

Opsi

Opsi singkat	Opsi panjang	Deskripsi	Contoh
-p	--updateProject	Proyek yang akan dioperasikan.	dotnet openapi refresh --updateProject .\Ref.csproj https://contoso.com/openapi.json
-h	--help	Perlihatkan informasi bantuan	dotnet openapi refresh --help

Argumen

Argumen	Deskripsi	Contoh
URL sumber	URL untuk merefresh referensi.	dotnet openapi refresh https://contoso.com/openapi.json