Szablon adresu URL szczegółów właściciela

Kanały informacyjne pakietów, które mają strony profilu właściciela, mogą informować narzędzia klienckie o sposobie konstruowania adresu URL profilu za pomocą tego szablonu. Jest to przydatne, gdy źródło pakietu chce włączyć wszystkie środowiska klienta (nawet innych firm) w celu połączenia ze stroną profilu określonego właściciela pakietu.

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

Versioning

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

@type Wartość Notes
OwnerDetailsUriTemplate/6.11.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 .

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

https://www.nuget.org/profiles/{owner}

Metody HTTP

Mimo że klient nie ma na celu wysłania żądań do adresu URL szczegółów właściciela 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

Zasób wyszukiwania zwraca informacje o właścicielu pakietu, w tym nazwy użytkowników właściciela. Biorąc pod uwagę nazwę użytkownika właściciela z zasobu wyszukiwania, implementacja klienta może utworzyć adres URL używany do uzyskiwania dostępu do interfejsu internetowego. Implementacja klienta powinna wyświetlać 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 uzyskanie dodatkowych informacji o właścicielu. Zawartość strony szczegółów właściciela 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 jest ciągiem adresu URL zawierającym następujący token zastępczy:

Symbole zastępcze adresu URL

Name Typ Required Notes
{owner} ciąg yes Nazwa użytkownika właściciela, aby uzyskać szczegółowe informacje dotyczące

Klient powinien zachować wielkość liter nazwy użytkownika w dowolnej formie, która została znaleziona w innych odpowiedziach interfejsu API lub w podpisie repozytorium pakietów. NuGet.org traktuje nazwy użytkowników właściciela w sposób niewrażliwy, ale nie wszystkie źródła pakietów mogą mieć tę elastyczność.

Jeśli na przykład implementacja klienta musi wyświetlić link do strony szczegółów właściciela właściciela Microsoft, spowoduje to utworzenie następującego adresu URL i podanie go użytkownikowi:

https://www.nuget.org/profiles/Microsoft