Szablon identyfikatora URI README
Istnieje możliwość utworzenia przez klienta adresu URL, który może służyć do pobierania pliku README dla określonego pakietu. Umożliwi to klientom renderowanie pliku README pakietu bez pobierania całego pakietu.
Zasób używany do tworzenia tego adresu URL to zasób ReadmeUriTemplate znaleziony w indeksie usługi .
Przechowywanie wersji
Używane są następujące wartości @type:
| @type wartość | Notatki |
|---|---|
| ReadmeUriTemplate/6.13.0 | Wersja początkowa |
Szablon adresu URL
Adres URL następującego interfejsu API to wartość właściwości @id skojarzonej z jedną z wyżej wymienionych wartości @type zasobów.
Metody HTTP
Skonstruowany adres URL musi obsługiwać metodę HTTP GET
Konstruowanie adresu URL
Biorąc pod uwagę znany identyfikator i wersję pakietu, implementacja klienta może utworzyć adres URL do pobrania pliku README.
Wartość @id to ciąg adresu URL zawierający dowolny z następujących tokenów zastępczych:
Symbole zastępcze adresu URL
| Nazwa | Typ | Wymagane | Notatki |
|---|---|---|---|
{lower_id} |
struna | tak | Identyfikator pakietu, małe litery |
{lower_version} |
struna | tak | Wersja pakietu, małe litery |
Zarówno lower_id, jak i lower_version są małe litery przy użyciu reguł implementowanych przez program . Net
System.String.ToLowerInvariant() metoda.
lower_version to żądana wersja pakietu znormalizowana przy użyciu reguł normalizacji wersji nuGet . Oznacza to, że w tym przypadku należy wykluczyć metadane kompilacji dozwolone przez specyfikację SemVer 2.0.0.
Treść odpowiedzi
Jeśli pakiet ma plik readme, zostanie zwrócony kod stanu 200. Treść odpowiedzi będzie samą zawartością readme.
Jeśli pakiet nie ma pliku readme, zostanie zwrócony kod stanu 404.