Шаблон URL-адреса сведений о пакете

Статья
10/23/2023

Клиент может создать URL-адрес, который может использоваться пользователем для просмотра дополнительных сведений о пакете в веб-браузере. Это полезно, если источник пакета хочет отобразить дополнительные сведения о пакете, который может не соответствовать область того, что отображает клиентское приложение NuGet.

Ресурс, используемый для создания этого URL-адреса, является ресурсомPackageDetailsUriTemplate, найденным в индексе службы.

Управление версиями

Допустимы следующие значения @type:

Значение @type	Примечания.
PackageDetailsUriTemplate/5.1.0	Начальный выпуск

Шаблон URL

URL-адрес для следующего API — это значение @id свойства, связанного с одним из указанных выше упоминание значений ресурсов@type.

Методы HTTP

Хотя клиент не предназначен для отправки запросов к URL-адресу сведений о пакете от имени пользователя, веб-страница должна поддерживать GET метод, чтобы разрешить доступ к url-адресу, щелкнувшему URL-адрес, легко открыться в веб-браузере.

Создание URL-адреса

Учитывая известный идентификатор пакета и версию, реализация клиента может создать URL-адрес, используемый для доступа к веб-интерфейсу. Реализация клиента должна отобразить этот созданный URL-адрес (или ссылку, доступную для щелчка) пользователю, позволяя им открыть веб-браузер по URL-адресу и узнать больше о пакете. Содержимое страницы сведений о пакете определяется реализацией сервера.

URL-адрес должен быть абсолютным URL-адресом, а схема (протокол) должна быть HTTPS.

Значение @id индекса службы — это строка URL-адреса, содержащая любой из следующих маркеров заполнителя:

Заполнители URL-адресов

Имя.	Type	Обязательное поле	Примечания.
`{id}`	строка	no	Идентификатор пакета для получения сведений
`{version}`	строка	no	Версия пакета для получения сведений

Сервер должен принимать {id} и {version} значения с любым регистром. Кроме того, сервер не должен учитывать нормализованную версию. Другими словами, сервер должен принимать также ненормализованные версии.

Например, шаблон сведений о пакете nuget.org выглядит следующим образом:

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

Если реализация клиента должна отобразить ссылку на сведения о пакете для NuGet.Versioning 4.3.0, он создаст следующий URL-адрес и предоставит его пользователю:

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

Поделиться через