Szablon adresu URL szczegółów pakietu

Istnieje możliwość utworzenia przez klienta adresu URL, który może być używany przez użytkownika do wyświetlania dodatkowych szczegółów pakietu w przeglądarce internetowej. Jest to przydatne, gdy źródło pakietu chce wyświetlić dodatkowe informacje o pakiecie, które mogą nie mieścić się w zakresie wyświetlania aplikacji klienckiej NuGet.

Zasób używany do tworzenia tego adresu URL jest zasobem PackageDetailsUriTemplate znajdującym się w indeksie usługi.

Wersje

Używane są następujące @type wartości:

@type Wartość	Uwagi
PackageDetailsUriTemplate/5.1.0	Wersja początkowa

Szablon adresu URL

Adres URL następującego interfejsu API to wartość @id właściwości skojarzonej z jedną z wyżej wymienionych wartości zasobów @type .

Metody HTTP

Mimo że klient nie ma na celu wysłania żądań do adresu URL szczegółów pakietu w imieniu użytkownika, strona internetowa powinna obsługiwać GET metodę umożliwiającą łatwe otwieranie klikniętego adresu URL w przeglądarce internetowej.

Konstruowanie adresu URL

Biorąc pod uwagę znany identyfikator i wersję pakietu, implementacja klienta może utworzyć adres URL używany do uzyskiwania dostępu do interfejsu internetowego. Implementacja klienta powinna wyświetlić ten skonstruowany adres URL (lub link możliwy do kliknięcia) użytkownikowi, aby umożliwić mu otwarcie przeglądarki internetowej pod adresem URL i dowiedzieć się więcej o pakiecie. Zawartość strony szczegółów pakietu jest określana przez implementację serwera.

Adres URL musi być bezwzględnym adresem URL, a schemat (protokół) musi być https.

Wartość @id w indeksie usługi to ciąg adresu URL zawierający dowolny z następujących tokenów zastępczych:

Symbole zastępcze adresu URL

Nazwisko	Type	Wymagania	Uwagi
{id}	string	nie	Identyfikator pakietu, aby uzyskać szczegółowe informacje dotyczące
{version}	string	nie	Wersja pakietu, aby uzyskać szczegółowe informacje dotyczące

Serwer powinien akceptować {id} i {version} wartości z dowolną wielkością liter. Ponadto serwer nie powinien być wrażliwy na to, czy wersja jest znormalizowana. Innymi słowy, serwer powinien zaakceptować również nienormalizowane wersje.

Na przykład szablon szczegółów pakietu nuget.org wygląda następująco:

https://www.nuget.org/packages/{id}/{version}

Jeśli implementacja klienta musi wyświetlić link do szczegółów pakietu dla pakietu NuGet.Versioning 4.3.0, powinien on utworzyć następujący adres URL i podać go użytkownikowi:

https://www.nuget.org/packages/NuGet.Versioning/4.3.0