Templat URL detail paket
Klien dapat membuat URL yang dapat digunakan oleh pengguna untuk melihat detail paket lebih lanjut di browser web mereka. Ini berguna ketika sumber paket ingin menampilkan informasi tambahan tentang paket yang mungkin tidak sesuai dalam cakupan apa yang ditampilkan aplikasi klien NuGet.
Sumber daya yang digunakan untuk membangun URL ini adalah sumber daya yang PackageDetailsUriTemplate
ditemukan dalam indeks layanan.
Nilai berikut @type
digunakan:
@type nilai | Catatan |
---|---|
PackageDetailsUriTemplate/5.1.0 | Rilis awal |
URL untuk API berikut adalah nilai properti yang @id
terkait dengan salah satu nilai sumber daya @type
yang disebutkan di atas.
Meskipun klien tidak dimaksudkan untuk membuat permintaan ke URL detail paket atas nama pengguna, halaman web harus mendukung GET
metode untuk memungkinkan URL yang diklik dibuka dengan mudah di browser web.
Mengingat ID dan versi paket yang diketahui, implementasi klien dapat membuat URL yang digunakan untuk mengakses antarmuka web. Implementasi klien harus menampilkan URL yang dibangun ini (atau tautan yang dapat diklik) kepada pengguna yang memungkinkan mereka membuka browser web ke URL dan untuk mempelajari lebih lanjut tentang paket tersebut. Konten halaman detail paket ditentukan oleh implementasi server.
URL harus berupa URL absolut dan skema (protokol) harus HTTPS.
Nilai @id
dalam indeks layanan adalah string URL yang berisi salah satu token tempat penampung berikut:
Nama | Tipe | Diperlukan | Catatan |
---|---|---|---|
{id} |
string | no | ID paket untuk mendapatkan detail |
{version} |
string | no | Versi paket untuk mendapatkan detail |
Server harus menerima {id}
dan {version}
nilai dengan casing apa pun. Selain itu, server tidak boleh sensitif terhadap apakah versi dinormalisasi. Dengan kata lain, server harus menerima juga menerima versi yang tidak dinormalisasi.
Misalnya, templat detail paket nuget.org terlihat seperti ini:
https://www.nuget.org/packages/{id}/{version}
Jika implementasi klien perlu menampilkan tautan ke detail paket untuk NuGet.Versioning 4.3.0, itu akan menghasilkan URL berikut dan memberikannya kepada pengguna:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0