README-URI-Vorlage
Es ist möglich, dass ein Client eine URL erstellt, die zum Herunterladen einer README für ein bestimmtes Paket verwendet werden kann. Dadurch können die Clients die README-Datei des Pakets rendern, ohne das gesamte Paket herunterzuladen.
Die Zum Erstellen dieser URL verwendete Ressource ist die ReadmeUriTemplate Ressource, die im Dienstindexgefunden wird.
Versionsverwaltung
Die folgenden @type Werte werden verwendet:
| wert @type | Notizen |
|---|---|
| ReadmeUriTemplate/6.13.0 | Die erste Version |
URL-Vorlage
Die URL für die folgende API ist der Wert der @id-Eigenschaft, die einem der oben genannten Ressourcen-@type-Werte zugeordnet ist.
HTTP-Methoden
Die erstellte URL muss die HTTP-Methode GET
Erstellen der URL
Aufgrund einer bekannten Paket-ID und -Version kann die Clientimplementierung eine URL erstellen, um die README herunterzuladen.
Der Wert der @id ist eine URL-Zeichenfolge, die eines der folgenden Platzhaltertoken enthält:
URL-Platzhalter
| Name | Art | Erforderlich | Notizen |
|---|---|---|---|
{lower_id} |
Schnur | ja | Die Paket-ID, kleingeschrieben |
{lower_version} |
Schnur | ja | Die Paketversion, kleingeschrieben |
Sowohl lower_id als auch lower_version werden mit den von ihnen implementierten Regeln kleingeschrieben. NET's
System.String.ToLowerInvariant()-Methode.
Die lower_version ist die gewünschte Paketversion, die mithilfe der NuGet-Version Normalisierungsregelnnormalisiert wird. Dies bedeutet, dass Buildmetadaten, die von der SemVer 2.0.0-Spezifikation zulässig sind, in diesem Fall ausgeschlossen werden müssen.
Antworttext
Wenn das Paket über eine Infodatei verfügt, wird ein Statuscode von 200 zurückgegeben. Der Antworttext ist der Inhalt der Infodatei selbst.
Wenn das Paket keine Infodatei enthält, wird ein 404-Statuscode zurückgegeben.