Dorong dan Hapus
Dimungkinkan untuk mendorong, menghapus (atau membatalkan daftar, tergantung pada implementasi server), dan paket relist menggunakan API NuGet V3. Operasi ini didasarkan pada sumber daya yang PackagePublish
ditemukan dalam indeks layanan.
Nilai berikut @type
digunakan:
@type nilai | Catatan |
---|---|
PackagePublish/2.0.0 | Rilis awal |
URL dasar untuk API berikut adalah nilai @id
properti PackagePublish/2.0.0
sumber daya dalam indeks layanan sumber paket. Untuk dokumentasi di bawah ini, URL nuget.org digunakan. Pertimbangkan https://www.nuget.org/api/v2/package
sebagai tempat penampung untuk nilai yang @id
ditemukan dalam indeks layanan.
Perhatikan bahwa URL ini menunjuk ke lokasi yang sama dengan titik akhir push V2 warisan karena protokolnya sama.
Metode PUT
, POST
dan DELETE
HTTP didukung oleh sumber daya ini. Untuk metode mana yang didukung pada setiap titik akhir, lihat di bawah ini.
Catatan
nuget.org memiliki persyaratan tambahan untuk berinteraksi dengan titik akhir push.
nuget.org mendukung pendorongan paket baru menggunakan API berikut. Jika paket dengan ID dan versi yang disediakan sudah ada, nuget.org akan menolak pendorongan. Sumber paket lain mungkin mendukung mengganti paket yang ada.
PUT https://www.nuget.org/api/v2/package
Nama | Dalam | Jenis | Diperlukan | Catatan |
---|---|---|---|---|
X-NuGet-ApiKey | Header | string | yes | Misalnya: X-NuGet-ApiKey: {USER_API_KEY} |
Kunci API adalah string buram yang diperoleh dari sumber paket oleh pengguna dan dikonfigurasi ke klien. Tidak ada format string tertentu yang diamanatkan tetapi panjang kunci API tidak boleh melebihi ukuran yang wajar untuk nilai header HTTP.
Isi permintaan harus datang dalam formulir berikut:
Header Content-Type
permintaan adalah multipart/form-data
dan item pertama dalam isi permintaan adalah byte mentah dari .nupkg yang sedang didorong. Item berikutnya dalam isi multibagian diabaikan. Nama file atau header lain dari item multibagian diabaikan.
Kode status | Makna |
---|---|
201, 202 | Paket berhasil didorong |
400 | Paket yang disediakan tidak valid |
409 | Paket dengan ID dan versi yang disediakan sudah ada |
Implementasi server bervariasi pada kode status keberhasilan yang dikembalikan ketika paket berhasil didorong.
nuget.org menginterpretasikan permintaan penghapusan paket sebagai "unlist". Ini berarti bahwa paket masih tersedia untuk konsumen paket yang ada tetapi paket tidak lagi muncul di hasil pencarian atau di antarmuka web. Untuk informasi selengkapnya tentang praktik ini, lihat kebijakan Paket yang Dihapus. Implementasi server lain bebas untuk menginterpretasikan sinyal ini sebagai penghapusan keras, penghapusan sementara, atau unlist. Misalnya, NuGet.Server (implementasi server yang hanya mendukung API V2 yang lebih lama) mendukung penanganan permintaan ini sebagai unlist atau hard delete berdasarkan opsi konfigurasi.
DELETE https://www.nuget.org/api/v2/package/{ID}/{VERSION}
Nama | Dalam | Jenis | Diperlukan | Catatan |
---|---|---|---|---|
ID | URL | string | yes | ID paket yang akan dihapus |
VERSION | URL | string | yes | Versi paket yang akan dihapus |
X-NuGet-ApiKey | Header | string | yes | Misalnya: X-NuGet-ApiKey: {USER_API_KEY} |
Kode status | Makna |
---|---|
204 | Paket dihapus |
404 | Tidak ada paket dengan yang disediakan ID dan VERSION ada |
Jika paket tidak terdata, dimungkinkan untuk membuat paket tersebut sekali lagi terlihat dalam hasil pencarian menggunakan titik akhir "daftar ulang". Titik akhir ini memiliki bentuk yang sama dengan titik akhir hapus (tidak daftar) tetapi menggunakan POST
metode HTTP alih-alih DELETE
metode .
Jika paket sudah tercantum, permintaan masih berhasil.
POST https://www.nuget.org/api/v2/package/{ID}/{VERSION}
Nama | Dalam | Jenis | Diperlukan | Catatan |
---|---|---|---|---|
ID | URL | string | yes | ID paket yang akan di-relist |
VERSION | URL | string | yes | Versi paket yang akan di-relist |
X-NuGet-ApiKey | Header | string | yes | Misalnya: X-NuGet-ApiKey: {USER_API_KEY} |
Kode status | Makna |
---|---|
200 | Paket sekarang tercantum |
404 | Tidak ada paket dengan yang disediakan ID dan VERSION ada |