Шаблон URI README

Статья
02/20/2025

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

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

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

Используются следующие @type значения:

значение @type	Примечания
ReadmeUriTemplate/6.13.0	Первоначальный выпуск

Шаблон URL-адреса

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

Методы HTTP

Созданный URL-адрес должен поддерживать метод HTTP GET

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

Учитывая известный идентификатор пакета и версию, реализация клиента может создать URL-адрес для скачивания README.

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

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

Имя	Тип	Обязательно	Примечания
`{lower_id}`	струна	да	Идентификатор пакета, нижний регистр
`{lower_version}`	струна	да	Версия пакета, в нижнем регистре

Оба lower_id и lower_version строчные регистры используются правилами, реализованными. NET метод System.String.ToLowerInvariant().

lower_version — это требуемая версия пакета, нормализованная с помощью правил нормализации NuGet. Это означает, что в данном случае необходимо исключить метаданные сборки, разрешенные спецификацией SemVer 2.0.0.

Текст ответа

Если пакет содержит readme, возвращается код состояния 200. Текст ответа будет сам содержимым readme.

Если пакет не содержит readme, возвращается код состояния 404.

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